SearchSpec

Specifica di ricerca.

Rappresentazione JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "searchParams": {
    object (SearchParams)
  },
  "searchResultList": {
    object (SearchResultList)
  }
  // End of mutually exclusive fields.
}
Campi
Parametri di ricerca per controllare il comportamento di ricerca. In alternativa, fornisci l'elenco dei risultati di ricerca per generare la risposta. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi:
searchParams

object (SearchParams)

Parametri di ricerca.
searchResultList

object (SearchResultList)

Elenco dei risultati di ricerca.
Fine dei campi che si escludono a vicenda.

SearchParams

Parametri di ricerca.

Rappresentazione JSON 
{
  "maxReturnResults": integer,
  "filter": string,
  "boostSpec": {
    object (BoostSpec)
  },
  "orderBy": string,
  "searchResultMode": enum (SearchResultMode),
  "dataStoreSpecs": [
    {
      object (DataStoreSpec)
    }
  ],
  "naturalLanguageQueryUnderstandingSpec": {
    object (NaturalLanguageQueryUnderstandingSpec)
  }
}
Campi
maxReturnResults

integer

Numero di risultati di ricerca da restituire. Il valore predefinito è 10.
filter

string

La sintassi del filtro è costituita da un linguaggio di espressione per costruire un predicato da uno o più campi dei documenti filtrati. L'espressione di filtro è sensibile alle maiuscole. Verrà utilizzato per filtrare i risultati di ricerca, il che potrebbe influire sulla risposta di Answer.

Se questo campo non è riconoscibile, viene restituito un INVALID_ARGUMENT.

Il filtro in Vertex AI Search viene eseguito mappando la chiave del filtro LHS a una proprietà chiave definita nel backend di Vertex AI Search. Questa mappatura viene definita dal cliente nello schema. Ad esempio, i clienti di contenuti multimediali potrebbero avere un campo "nome" nel loro schema. In questo caso, il filtro sarà simile a questo: filter --> name:'ANY("king kong")'

Per saperne di più sul filtraggio, inclusi sintassi e operatori di filtro, consulta Filtro.
boostSpec

object (BoostSpec)

Specifica del boost per aumentare la visibilità di determinati documenti nei risultati di ricerca, il che potrebbe influire sulla risposta alla query. Per saperne di più sul boosting, consulta la sezione Boosting.
orderBy

string

L'ordine in cui vengono restituiti i documenti. I documenti possono essere ordinati in base a un campo in un oggetto Document. Lascia il campo vuoto se l'ordine è per pertinenza. L'espressione orderBy è sensibile alle maiuscole. Per ulteriori informazioni sugli ordini, consulta la sezione Ordini.

Se questo campo non è riconoscibile, viene restituito un INVALID_ARGUMENT.
searchResultMode

enum (SearchResultMode)

Specifica la modalità dei risultati di ricerca. Se non specificata, la modalità dei risultati di ricerca è impostata su DOCUMENTS per impostazione predefinita. Vedi analisi e suddivisione in blocchi dei documenti
dataStoreSpecs[]

object (DataStoreSpec)

Specifiche che definiscono i dataStore su cui filtrare in una chiamata di ricerca e configurazioni per questi dataStore. Questo viene preso in considerazione solo per i motori con più casi d'uso di datastore. Per un singolo datastore all'interno di un motore, devono utilizzare le specifiche di primo livello.
naturalLanguageQueryUnderstandingSpec

object (NaturalLanguageQueryUnderstandingSpec)

Facoltativo. Specifica per abilitare le funzionalità di comprensione del linguaggio naturale per le richieste di ricerca.

SearchResultList

Elenco dei risultati di ricerca.

Rappresentazione JSON 
{
  "searchResults": [
    {
      object (SearchResult)
    }
  ]
}
Campi
searchResults[]

object (SearchResult)

Risultati della ricerca.

SearchResult

Risultato di ricerca.

Rappresentazione JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "unstructuredDocumentInfo": {
    object (UnstructuredDocumentInfo)
  },
  "chunkInfo": {
    object (ChunkInfo)
  }
  // End of mutually exclusive fields.
}
Campi
Contenuti dei risultati di ricerca. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi:
unstructuredDocumentInfo

object (UnstructuredDocumentInfo)

Informazioni sui documenti non strutturati.
chunkInfo

object (ChunkInfo)

Informazioni sul segmento.
Fine dei campi che si escludono a vicenda.

UnstructuredDocumentInfo

Informazioni sui documenti non strutturati.

Rappresentazione JSON 
{
  "document": string,
  "uri": string,
  "title": string,
  "documentContexts": [
    {
      object (DocumentContext)
    }
  ],
  "extractiveSegments": [
    {
      object (ExtractiveSegment)
    }
  ],
  "extractiveAnswers": [
    {
      object (ExtractiveAnswer)
    }
  ]
}
Campi
document

string

Nome della risorsa del documento.
uri

string

L'URI del documento.
title

string

Titolo.
documentContexts[]

object (DocumentContext)

Elenco dei contesti del documento. I contenuti verranno utilizzati per la generazione di risposte. Questi dovrebbero essere i contenuti principali del documento, che possono essere lunghi e completi.
extractiveSegments[]

object (ExtractiveSegment)

Elenco dei segmenti estrattivi.
extractiveAnswers[]
(deprecated)

object (ExtractiveAnswer)

Deprecato: questo campo è deprecato e non avrà alcun effetto sulla generazione di risposte. Utilizza i campi documentContexts e extractiveSegments. Elenco delle risposte estrattive.

DocumentContext

Contesto del documento.

Rappresentazione JSON 
{
  "pageIdentifier": string,
  "content": string
}
Campi
pageIdentifier

string

Identificatore della pagina.
content

string

Contenuti del documento da utilizzare per la generazione delle risposte.

ExtractiveSegment

Segmento estrattivo. Guida La generazione di risposte lo utilizzerà solo se documentContexts è vuoto. Questi dovrebbero essere snippet più brevi.

Rappresentazione JSON 
{
  "pageIdentifier": string,
  "content": string
}
Campi
pageIdentifier

string

Identificatore della pagina.
content

string

Contenuti del segmento estrattivo.

ExtractiveAnswer

Risposta estrattiva. Guida

Rappresentazione JSON 
{
  "pageIdentifier": string,
  "content": string
}
Campi
pageIdentifier

string

Identificatore della pagina.
content

string

Contenuto della risposta estrattiva.

ChunkInfo

Informazioni sul segmento.

Rappresentazione JSON 
{
  "chunk": string,
  "content": string,
  "documentMetadata": {
    object (DocumentMetadata)
  }
}
Campi
chunk

string

Nome della risorsa chunk.
content

string

Dividi i contenuti testuali in blocchi.
documentMetadata

object (DocumentMetadata)

I metadati del documento del chunk corrente.

DocumentMetadata

I metadati del documento contengono le informazioni del documento del chunk corrente.

Rappresentazione JSON 
{
  "uri": string,
  "title": string
}
Campi
uri

string

L'URI del documento.
title

string

Il titolo del documento.