Método: corpora.documents.create
- Extremo
- Parámetros de ruta de acceso
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Permisos de autorización
Crea un Document
vacío.
Extremo
publicaciónhttps: / /generativelanguage.googleapis.com /v1beta /{parent=corpora /*} /documents
La URL usa la sintaxis de la transcodificación gRPC.
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
Tiene el formato corpora/{corpora}
.
Cuerpo de la solicitud
El cuerpo de la solicitud contiene una instancia de Document
.
name
string
Inmutable. 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 el momento de 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 del 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. Metadatos personalizados proporcionados por el usuario almacenados como pares clave-valor que 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
- Extremo
- Parámetros de ruta de acceso
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Permisos de autorización
Realiza una búsqueda semántica en un Document
.
Extremo
publicaciónhttps: / /generativelanguage.googleapis.com /v1beta /{name=corpora /* /documents /*}:query
La URL usa la sintaxis de la transcodificación gRPC.
Parámetros de ruta
name
string
Es obligatorio. Es el nombre de la Document
que se consultará. Ejemplo: corpora/my-corpus-123/documents/the-doc-abc
Tiene el formato corpora/{corpora}/documents/{document}
.
Cuerpo de la solicitud
El cuerpo de la solicitud contiene datos con la siguiente estructura:
query
string
Es obligatorio. Es la cadena de consulta para realizar una búsqueda semántica.
resultsCount
integer
Opcional. Es la cantidad máxima de Chunk
que se mostrarán. Es posible que el servicio devuelva menos Chunk
.
Si no se especifica, se mostrarán como máximo 10 Chunk
. La cantidad máxima de resultados especificados es 100.
metadataFilters[]
object (MetadataFilter
)
Opcional. Filtra los metadatos de Chunk
. Cada objeto MetadataFilter
debe corresponder a una clave única. Varios objetos MetadataFilter
se unen con "Y" lógicos.
Nota: El filtrado a nivel de Document
no se admite para esta solicitud porque ya se especificó un nombre Document
.
Ejemplo de consulta: (year >= 2020 OR year < 2010) AND (genre = drama OR genre = action)
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: (year > 2015 AND year <= 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 operadores "AND" para la misma clave solo se admiten para valores numéricos. Los valores de cadena solo admiten "O" 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:
relevantChunks[]
object (RelevantChunk
)
Los fragmentos relevantes que se muestran
Representación JSON |
---|
{
"relevantChunks": [
{
object ( |
Método: corpora.documents.list
- Extremo
- Parámetros de ruta de acceso
- Parámetros de consulta
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Permisos de autorización
Enumera todos los Document
en una Corpus
.
Extremo
gethttps: / /generativelanguage.googleapis.com /v1beta /{parent=corpora /*} /documents
La URL usa la sintaxis de la transcodificación gRPC.
Parámetros de ruta
parent
string
Es obligatorio. Es el nombre del Corpus
que contiene Document
. Ejemplo: corpora/my-corpus-123
Tiene el formato corpora/{corpora}
.
Parámetros de consulta
pageSize
integer
Opcional. Es la cantidad máxima de Document
que se mostrarán (por página). Es posible que el servicio devuelva menos Document
.
Si no se especifica, se mostrarán como máximo 10 Document
. 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 argumento para la siguiente solicitud para 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 Document
se ordenan por document.create_time
ascendente.
Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:
documents[]
object (Document
)
Los Document
que se devuelven.
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 ( |
Método: corpora.documents.get
- Extremo
- Parámetros de ruta de acceso
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Permisos de autorización
Obtén información sobre un Document
específico.
Extremo
gethttps: / /generativelanguage.googleapis.com /v1beta /{name=corpora /* /documents /*}
La URL usa la sintaxis de la transcodificación gRPC.
Parámetros de ruta
name
string
Es obligatorio. Es el nombre de la Document
que se recuperará. Ejemplo: corpora/my-corpus-123/documents/the-doc-abc
Tiene el formato 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
- Extremo
- Parámetros de ruta de acceso
- Parámetros de consulta
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Permisos de autorización
Actualiza un Document
.
Extremo
patchhttps: / /generativelanguage.googleapis.com /v1beta /{document.name=corpora /* /documents /*}
PATCH https://generativelanguage.googleapis.com/v1beta/{document.name=corpora/*/documents/*}
La URL usa la sintaxis de la transcodificación gRPC.
Parámetros de ruta
document.name
string
Inmutable. 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 el momento de 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
Tiene el formato 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
.
displayName
string
Opcional. Es el nombre visible legible por humanos del 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. Metadatos personalizados proporcionados por el usuario almacenados como pares clave-valor que 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
- Extremo
- Parámetros de ruta de acceso
- Parámetros de consulta
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Permisos de autorización
Borra una Document
.
Extremo
deletehttps: / /generativelanguage.googleapis.com /v1beta /{name=corpora /* /documents /*}
La URL usa la sintaxis de la transcodificación gRPC.
Parámetros de ruta
name
string
Es obligatorio. Es el nombre del recurso Document
que se borrará. Ejemplo: corpora/my-corpus-123/documents/the-doc-abc
Tiene el formato corpora/{corpora}/documents/{document}
.
Parámetros de consulta
force
boolean
Opcional. Si se establece como verdadero, también se borrarán todos los Chunk
y los objetos relacionados con este Document
.
Si es falso (el 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: Documento
Una Document
es una colección de elementos Chunk
. Un Corpus
puede tener un máximo de 10,000 Document
.
name
string
Inmutable. 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 el momento de 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 del 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. Metadatos personalizados proporcionados por el usuario almacenados como pares clave-valor que 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 de Document
.
Usa RFC 3339, en el que el resultado generado siempre se normalizará en Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan compensaciones distintas de "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 RFC 3339, en el que el resultado generado siempre se normalizará en Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan compensaciones distintas de "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
Metadatos proporcionados por el usuario almacenados como pares clave-valor.
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
Valores de cadena proporcionados por el usuario asignados a una sola clave de metadatos.
values[]
string
Los valores de cadena de los metadatos que se almacenarán.
Representación JSON |
---|
{ "values": [ string ] } |