Method: documents.searchDocumentChunks

Cerca le conoscenze degli sviluppatori nella documentazione per gli sviluppatori di Google. Restituisce DocumentChunk in base alla query dell'utente. Potrebbero esserci molti chunk dello stesso Document. Per recuperare i documenti completi, utilizza DeveloperKnowledge.GetDocument o DeveloperKnowledge.BatchGetDocuments con DocumentChunk.parent restituito in SearchDocumentChunksResponse.results.

Richiesta HTTP

GET https://developerknowledge.googleapis.com/v1/documents:searchDocumentChunks

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri di query

Parametri
query

string

Obbligatorio. Fornisce la stringa di query non elaborata fornita dall'utente, ad esempio "Come creare un bucket Cloud Storage?".
pageSize

integer

Facoltativo. Specifica il numero massimo di risultati da restituire. Il servizio potrebbe restituire un numero inferiore a questo valore.

Se non specificato, verranno restituiti al massimo 5 risultati.

Il valore massimo è 100; i valori superiori a 100 verranno forzati a 100.
pageToken

string

Facoltativo. Contiene un token di pagina, ricevuto da una precedente chiamata documents.searchDocumentChunks. Forniscilo per recuperare la pagina successiva.
filter

string

Facoltativo. Applica un filtro rigoroso ai risultati di ricerca. L'espressione supporta un sottoinsieme della sintassi descritta all'indirizzo https://google.aip.dev/160.

Mentre documents.searchDocumentChunks restituisce DocumentChunk, il filtro viene applicato ai campi DocumentChunk.document.

Campi supportati per il filtro:

  • contentLengthBytes (INTEGER): la lunghezza del campo Document.content in byte.
  • dataSource (STRINGA): l'origine del documento, ad esempio docs.cloud.google.com. Consulta https://developers.google.com/knowledge/reference/corpus-reference per l'elenco completo delle origini dati nel corpus.
  • updateTime (TIMESTAMP): il timestamp dell'ultimo aggiornamento significativo del documento. Un aggiornamento significativo è quello che modifica i contenuti o i metadati Markdown del documento.
  • uri (STRINGA): l'URI del documento, ad es. https://docs.cloud.google.com/bigquery/docs/tables.

I campi INTEGER supportano gli operatori =, <, <=, > e >=.

I campi STRING supportano gli operatori = (uguale a) e != (diverso da) per la corrispondenza esatta dell'intera stringa. La corrispondenza parziale, la corrispondenza del prefisso e la corrispondenza con espressione regolare non sono supportate.

I campi TIMESTAMP supportano gli operatori =, <, <=, > e >=. I timestamp devono essere nel formato RFC-3339, ad esempio "2025-01-01T00:00:00Z".

Puoi combinare le espressioni utilizzando gli operatori logici AND, OR e NOT (o -). OR ha una priorità più alta rispetto a AND. Utilizza le parentesi per il raggruppamento esplicito della precedenza.

Esempi:

  • Filtra per Document.content_length_bytes: contentLengthBytes < 50000
  • dataSource = "docs.cloud.google.com" OR dataSource = "firebase.google.com"
  • dataSource != "firebase.google.com"
  • updateTime < "2024-01-01T00:00:00Z"
  • updateTime >= "2025-01-22T00:00:00Z" AND (dataSource = "developer.chrome.com" OR dataSource = "web.dev")
  • uri = "https://docs.cloud.google.com/release-notes"

La stringa filter non deve superare i 500 caratteri; i valori più lunghi di 500 caratteri genereranno un errore INVALID_ARGUMENT.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

Messaggio di risposta per DeveloperKnowledge.SearchDocumentChunks.

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

Rappresentazione JSON 
{
  "results": [
    {
      object (DocumentChunk)
    }
  ],
  "nextPageToken": string
}
Campi
results[]

object (DocumentChunk)

Contiene i risultati di ricerca per la query specificata. Ogni DocumentChunk di questo elenco contiene un snippet di contenuti pertinenti alla query di ricerca. Utilizza il campo DocumentChunk.parent di ogni risultato con DeveloperKnowledge.GetDocument o DeveloperKnowledge.BatchGetDocuments per recuperare i contenuti completi del documento.
nextPageToken

string

Facoltativo. Fornisce un token che può essere inviato come pageToken per recuperare la pagina successiva. Se questo campo viene omesso, non verranno visualizzate altre pagine.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/devprofiles.full_control
  • https://www.googleapis.com/auth/cloud-platform

Per saperne di più, consulta la OAuth 2.0 Overview.

DocumentChunk

Un DocumentChunk rappresenta una parte di contenuti di un Document nel corpus DeveloperKnowledge. Per recuperare l'intero contenuto del documento, passa parent a DeveloperKnowledge.GetDocument o DeveloperKnowledge.BatchGetDocuments.

Rappresentazione JSON 
{
  "parent": string,
  "id": string,
  "content": string,
  "document": {
    object (Document)
  }
}
Campi
parent

string

Solo output. Contiene il nome della risorsa del documento da cui proviene questo chunk. Formato: documents/{uri_without_scheme} Esempio: documents/docs.cloud.google.com/storage/docs/creating-buckets
id

string

Solo output. Specifica l'ID di questo blocco all'interno del documento. L'ID blocco è univoco all'interno di un documento, ma non a livello globale tra i documenti. L'ID chunk non è stabile e potrebbe cambiare nel tempo.
content

string

Solo output. Contiene i contenuti del blocco del documento.
document

object (Document)

Solo output. Rappresenta i metadati relativi al Document da cui proviene questo chunk. Il DocumentView di questo messaggio Document verrà impostato su DOCUMENT_VIEW_BASIC. È incluso qui per comodità, in modo che i clienti non debbano chiamare DeveloperKnowledge.GetDocument o DeveloperKnowledge.BatchGetDocuments se hanno bisogno solo dei campi dei metadati. In caso contrario, i client devono utilizzare DeveloperKnowledge.GetDocument o DeveloperKnowledge.BatchGetDocuments per recuperare l'intero contenuto del documento.