Documents

Metodo: corpora.documents.create

Crea un Document vuoto.

Endpoint

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

parent string

Obbligatorio. Il nome del Corpus in cui verrà creato questo Document. Esempio: corpora/my-corpus-123 assume la forma corpora/{corpora}.

Corpo della richiesta

Il corpo della richiesta contiene un'istanza di Document.

Campi
name string

Immutabile. Identificatore. Il nome della risorsa Document. L'ID (nome escluso il prefisso "corpora/*/documents/") può contenere fino a 40 caratteri alfanumerici minuscoli o trattini (-). L'ID non può iniziare o terminare con un trattino. Se il nome è vuoto al momento della creazione, verrà generato un nome univoco da displayName insieme a un suffisso casuale di 12 caratteri. Esempio: corpora/{corpus_id}/documents/my-awesome-doc-123a456b789c

displayName string

Facoltativo. Il nome visualizzato leggibile per Document. Il nome visualizzato non deve contenere più di 512 caratteri, spazi inclusi. Esempio: "Documentazione di Semantic Retriever"

customMetadata[] object (CustomMetadata)

Facoltativo. Metadati personalizzati forniti dall'utente memorizzati come coppie chiave/valore utilizzate per le query. Un Document può avere un massimo di 20 CustomMetadata.

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene un'istanza di Document appena creata.

Metodo: corpora.documents.query

Esegue una ricerca semantica su un Document.

Endpoint

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

name string

Obbligatorio. Il nome del Document su cui eseguire la query. Esempio: corpora/my-corpus-123/documents/the-doc-abc assume la forma corpora/{corpora}/documents/{document}.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Campi
query string

Obbligatorio. Stringa di query per eseguire una ricerca semantica.

resultsCount integer

Facoltativo. Il numero massimo di Chunk da restituire. Il servizio potrebbe restituire meno Chunk.

Se non specificato, verranno restituiti al massimo 10 Chunk. Il numero massimo di risultati specificati è 100.

metadataFilters[] object (MetadataFilter)

Facoltativo. Filtra in base ai metadati Chunk. Ogni oggetto MetadataFilter deve corrispondere a una chiave univoca. Più oggetti MetadataFilter sono uniti da "AND" logici.

Nota: il filtro a livello di Document non è supportato per questa richiesta perché è già specificato un nome Document.

Query di esempio: (year >= 2020 OR year < 2010) AND (genre = drama OR genre = action)

MetadataFilter elenco di oggetti: 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}}]

Query di esempio per un intervallo di valori numerici: (year > 2015 AND year <= 2020)

MetadataFilter elenco di oggetti: 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: i "AND" per la stessa chiave sono supportati solo per i valori numerici. I valori stringa supportano solo gli operatori "OR" per la stessa chiave.

Corpo della risposta

Risposta di documents.query contenente un elenco di chunk pertinenti.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Campi
relevantChunks[] object (RelevantChunk)

I chunk pertinenti restituiti.

Rappresentazione JSON
{
  "relevantChunks": [
    {
      object (RelevantChunk)
    }
  ]
}

Metodo: corpora.documents.list

Elenca tutti i Document in un Corpus.

Endpoint

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

parent string

Obbligatorio. Il nome del Corpus contenente Document. Esempio: corpora/my-corpus-123 assume la forma corpora/{corpora}.

Parametri di query

pageSize integer

Facoltativo. Il numero massimo di Document da restituire (per pagina). Il servizio potrebbe restituire meno Document.

Se non specificato, verranno restituiti al massimo 10 Document. Il limite di dimensione massima è 20 Document per pagina.

pageToken string

Facoltativo. Un token di pagina ricevuto da una chiamata documents.list precedente.

Fornisci il valore nextPageToken restituito nella risposta come argomento alla richiesta successiva per recuperare la pagina successiva.

Quando viene applicata la paginazione, tutti gli altri parametri forniti a documents.list devono corrispondere alla chiamata che ha fornito il token pagina.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

Risposta di documents.list contenente un elenco paginato di Document. I Document sono ordinati in base al document.create_time crescente.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Campi
documents[] object (Document)

I Document restituiti.

nextPageToken string

Un token che può essere inviato come pageToken per recuperare la pagina successiva. Se questo campo viene omesso, non ci sono altre pagine.

Rappresentazione JSON
{
  "documents": [
    {
      object (Document)
    }
  ],
  "nextPageToken": string
}

Metodo: corpora.documents.get

Recupera le informazioni su un Document specifico.

Endpoint

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

name string

Obbligatorio. Il nome del Document da recuperare. Esempio: corpora/my-corpus-123/documents/the-doc-abc assume la forma corpora/{corpora}/documents/{document}.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene un'istanza di Document.

Metodo: corpora.documents.patch

Aggiorna un Document.

Endpoint

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

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

document.name string

Immutabile. Identificatore. Il nome della risorsa Document. L'ID (nome escluso il prefisso "corpora/*/documents/") può contenere fino a 40 caratteri alfanumerici minuscoli o trattini (-). L'ID non può iniziare o terminare con un trattino. Se il nome è vuoto al momento della creazione, verrà generato un nome univoco da displayName insieme a un suffisso casuale di 12 caratteri. Esempio: corpora/{corpus_id}/documents/my-awesome-doc-123a456b789c assume la forma corpora/{corpora}/documents/{document}.

Parametri di query

updateMask string (FieldMask format)

Obbligatorio. L'elenco dei campi da aggiornare. Al momento, è supportato solo l'aggiornamento di displayName e customMetadata.

Si tratta di un elenco separato da virgole di nomi completi dei campi. Esempio: "user.displayName,photo".

Corpo della richiesta

Il corpo della richiesta contiene un'istanza di Document.

Campi
displayName string

Facoltativo. Il nome visualizzato leggibile per Document. Il nome visualizzato non deve contenere più di 512 caratteri, spazi inclusi. Esempio: "Documentazione di Semantic Retriever"

customMetadata[] object (CustomMetadata)

Facoltativo. Metadati personalizzati forniti dall'utente memorizzati come coppie chiave/valore utilizzate per le query. Un Document può avere un massimo di 20 CustomMetadata.

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene un'istanza di Document.

Metodo: corpora.documents.delete

Consente di eliminare un Document.

Endpoint

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

name string

Obbligatorio. Il nome della risorsa del Document da eliminare. Esempio: corpora/my-corpus-123/documents/the-doc-abc assume la forma corpora/{corpora}/documents/{document}.

Parametri di query

force boolean

Facoltativo. Se impostata su true, verranno eliminati anche tutti i Chunk e gli oggetti correlati a questo Document.

Se è false (il valore predefinito), verrà restituito un errore FAILED_PRECONDITION se Document contiene Chunk.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

In caso di esito positivo, il corpo della risposta è un oggetto JSON vuoto.

Risorsa REST: corpora.documents

Risorsa: documento

Un Document è una raccolta di Chunk. Un Corpus può avere un massimo di 10.000 Document.

Campi
name string

Immutabile. Identificatore. Il nome della risorsa Document. L'ID (nome escluso il prefisso "corpora/*/documents/") può contenere fino a 40 caratteri alfanumerici minuscoli o trattini (-). L'ID non può iniziare o terminare con un trattino. Se il nome è vuoto al momento della creazione, verrà generato un nome univoco da displayName insieme a un suffisso casuale di 12 caratteri. Esempio: corpora/{corpus_id}/documents/my-awesome-doc-123a456b789c

displayName string

Facoltativo. Il nome visualizzato leggibile per Document. Il nome visualizzato non deve contenere più di 512 caratteri, spazi inclusi. Esempio: "Documentazione di Semantic Retriever"

customMetadata[] object (CustomMetadata)

Facoltativo. Metadati personalizzati forniti dall'utente memorizzati come coppie chiave/valore utilizzate per le query. Un Document può avere un massimo di 20 CustomMetadata.

updateTime string (Timestamp format)

Solo output. Il timestamp dell'ultimo aggiornamento di Document.

Utilizza RFC 3339, in cui l'output generato sarà sempre normalizzato in base a Z e utilizza 0, 3, 6 o 9 cifre decimali. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

createTime string (Timestamp format)

Solo output. Il timestamp della creazione di Document.

Utilizza RFC 3339, in cui l'output generato sarà sempre normalizzato in base a Z e utilizza 0, 3, 6 o 9 cifre decimali. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

Rappresentazione JSON
{
  "name": string,
  "displayName": string,
  "customMetadata": [
    {
      object (CustomMetadata)
    }
  ],
  "updateTime": string,
  "createTime": string
}

CustomMetadata

Metadati forniti dall'utente memorizzati come coppie chiave/valore.

Campi
key string

Obbligatorio. La chiave dei metadati da archiviare.

value Union type
value può essere solo uno dei seguenti:
stringValue string

Il valore stringa dei metadati da archiviare.

stringListValue object (StringList)

Il valore StringList dei metadati da memorizzare.

numericValue number

Il valore numerico dei metadati da archiviare.

Rappresentazione JSON
{
  "key": string,

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

StringList

Valori di stringa forniti dall'utente assegnati a una singola chiave dei metadati.

Campi
values[] string

I valori stringa dei metadati da archiviare.

Rappresentazione JSON
{
  "values": [
    string
  ]
}