SearchSpec

Specifica della ricerca.

Rappresentazione JSON 
{

  // Union field input can be only one of the following:
  "searchParams": {
    object (SearchParams)
  },
  "searchResultList": {
    object (SearchResultList)
  }
  // End of list of possible types for union field input.
}
Campi
Campo unione input. Parametri di ricerca per controllare il comportamento della ricerca. In alternativa, fornisci l'elenco dei risultati di ricerca per generare la risposta. input può essere solo uno dei seguenti:
searchParams

object (SearchParams)

Parametri di ricerca.
searchResultList

object (SearchResultList)

Elenco dei risultati di ricerca.

SearchParams

Parametri di ricerca.

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

integer

Il 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 da filtrare. L'espressione del filtro è sensibile alle maiuscole. Queste informazioni verranno utilizzate 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, un cliente di contenuti multimediali potrebbe avere un campo "nome" nel proprio 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 il ranking di determinati documenti nei risultati di ricerca, il che potrebbe influire sulla risposta alla query. Per ulteriori informazioni 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. Consulta Analizzare e dividere i documenti in blocchi.
dataStoreSpecs[]

object (DataStoreSpec)

Specifiche che definiscono i data store su cui filtrare in una chiamata di ricerca e configurazioni per questi data store. 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.

SearchResultList

Elenco dei risultati di ricerca.

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

object (SearchResult)

Risultati di ricerca.

SearchResult

Risultato di ricerca.

Rappresentazione JSON 
{

  // Union field content can be only one of the following:
  "unstructuredDocumentInfo": {
    object (UnstructuredDocumentInfo)
  },
  "chunkInfo": {
    object (ChunkInfo)
  }
  // End of list of possible types for union field content.
}
Campi
Campo unione content. Contenuti dei risultati di ricerca. content può essere solo uno dei seguenti:
unstructuredDocumentInfo

object (UnstructuredDocumentInfo)

Informazioni sui documenti non strutturati.
chunkInfo

object (ChunkInfo)

Informazioni sui chunk.

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

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)

Obsoleto: questo campo è obsoleto 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 generare le risposte.

ExtractiveSegment

Segmento estrattivo. Guida. La generazione di risposte la 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 sui chunk.

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

string

Nome della risorsa del blocco.
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 attuale.

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

string

L'URI del documento.
title

string

Il titolo del documento.