SearchSpec

Spécification de la recherche.

Représentation 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.
}
Champs
Champ d'union input. Paramètres de recherche permettant de contrôler le comportement de la recherche. Vous pouvez également fournir une liste de résultats de recherche pour générer une réponse. input ne peut être qu'un des éléments suivants :
searchParams

object (SearchParams)

Paramètres de recherche.
searchResultList

object (SearchResultList)

Liste des résultats de recherche.

SearchParams

Paramètres de recherche.

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

integer

Nombre de résultats de recherche à renvoyer. La valeur par défaut est 10.
filter

string

La syntaxe des filtres consiste en un langage d'expression permettant de construire un prédicat à partir d'un ou de plusieurs champs des documents filtrés. L'expression de filtre est sensible à la casse. Il sera utilisé pour filtrer les résultats de recherche, ce qui peut avoir une incidence sur la réponse.

Si ce champ n'est pas reconnaissable, un INVALID_ARGUMENT est renvoyé.

Le filtrage dans Vertex AI Search s'effectue en mappant la clé de filtre LHS à une propriété clé définie dans le backend Vertex AI Search. Ce mappage est défini par le client dans son schéma. Par exemple, un client média peut avoir un champ "name" dans son schéma. Dans ce cas, le filtre se présenterait comme suit : filter --> name:'ANY("king kong")`

Pour en savoir plus sur le filtrage, y compris sur la syntaxe et les opérateurs de filtre, consultez Filtrer.
boostSpec

object (BoostSpec)

Spécification de boost pour mettre en avant certains documents dans les résultats de recherche, ce qui peut avoir une incidence sur la réponse à la requête. Pour en savoir plus sur l'amplification, consultez Amplification.
orderBy

string

Ordre dans lequel les documents sont renvoyés. Les documents peuvent être triés par champ dans un objet Document. Laissez ce champ vide si les résultats sont triés par pertinence. L'expression orderBy est sensible à la casse. Pour en savoir plus sur la commande, consultez Commander.

Si ce champ n'est pas reconnaissable, un INVALID_ARGUMENT est renvoyé.
searchResultMode

enum (SearchResultMode)

Spécifie le mode des résultats de recherche. Si aucun mode n'est spécifié, le mode de résultat de recherche est défini par défaut sur DOCUMENTS. Consultez Analyser et fragmenter des documents.
dataStoreSpecs[]

object (DataStoreSpec)

Spécifications définissant les dataStores sur lesquels filtrer dans un appel de recherche et les configurations de ces dataStores. Cela n'est pris en compte que pour les moteurs avec plusieurs cas d'utilisation de dataStores. Pour un seul DataStore dans un moteur, ils doivent utiliser les spécifications au niveau supérieur.
naturalLanguageQueryUnderstandingSpec

object (NaturalLanguageQueryUnderstandingSpec)

Facultatif. Spécification permettant d'activer les fonctionnalités de compréhension du langage naturel pour les demandes de recherche.

SearchResultList

Liste des résultats de recherche.

Représentation JSON 
{
  "searchResults": [
    {
      object (SearchResult)
    }
  ]
}
Champs
searchResults[]

object (SearchResult)

Résultats de recherche.

SearchResult

Résultat de recherche.

Représentation 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.
}
Champs
Champ d'union content. Contenu des résultats de recherche. content ne peut être qu'un des éléments suivants :
unstructuredDocumentInfo

object (UnstructuredDocumentInfo)

Informations sur les documents non structurés.
chunkInfo

object (ChunkInfo)

Informations sur le fragment.

UnstructuredDocumentInfo

Informations sur les documents non structurés.

Représentation JSON 
{
  "document": string,
  "uri": string,
  "title": string,
  "documentContexts": [
    {
      object (DocumentContext)
    }
  ],
  "extractiveSegments": [
    {
      object (ExtractiveSegment)
    }
  ],
  "extractiveAnswers": [
    {
      object (ExtractiveAnswer)
    }
  ]
}
Champs
document

string

Nom de ressource du document.
uri

string

URI du document.
title

string

et le titre.
documentContexts[]

object (DocumentContext)

Liste des contextes de document. Le contenu sera utilisé pour la génération de réponses. Il s'agit du contenu principal du document, qui peut être long et complet.
extractiveSegments[]

object (ExtractiveSegment)

Liste des segments extractifs.
extractiveAnswers[]
(deprecated)

object (ExtractiveAnswer)

Obsolète : ce champ est obsolète et n'aura aucun effet sur la génération de réponses. Veuillez utiliser les champs "documentContexts" et "extractiveSegments". Liste des réponses extractives.

DocumentContext

Contexte du document.

Représentation JSON 
{
  "pageIdentifier": string,
  "content": string
}
Champs
pageIdentifier

string

Identifiant de la page.
content

string

Contenu du document à utiliser pour générer des réponses.

ExtractiveSegment

Segment extractif. Guide : la génération de réponses ne l'utilisera que si documentContexts est vide. Il s'agit de brefs extraits.

Représentation JSON 
{
  "pageIdentifier": string,
  "content": string
}
Champs
pageIdentifier

string

Identifiant de la page.
content

string

Contenu du segment d'extraction.

ExtractiveAnswer

Réponse extractive. Guide

Représentation JSON 
{
  "pageIdentifier": string,
  "content": string
}
Champs
pageIdentifier

string

Identifiant de la page.
content

string

Contenu de la réponse extractive.

ChunkInfo

Informations sur le fragment.

Représentation JSON 
{
  "chunk": string,
  "content": string,
  "documentMetadata": {
    object (DocumentMetadata)
  }
}
Champs
chunk

string

Nom de la ressource du bloc.
content

string

Contenu textuel du bloc.
documentMetadata

object (DocumentMetadata)

Métadonnées du document provenant du bloc actuel.

DocumentMetadata

Les métadonnées du document contiennent les informations du document du bloc actuel.

Représentation JSON 
{
  "uri": string,
  "title": string
}
Champs
uri

string

URI du document.
title

string

Titre du document.