SearchSpec

Spezifikation der Suche

JSON-Darstellung 
{

  // 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.
}
Felder
Suchparameter zum Steuern des Suchverhaltens. Oder geben Sie eine Liste mit Suchergebnissen an, um eine Antwort zu generieren. Im Folgenden finden Sie eine Liste von sich gegenseitig ausschließenden Feldern. In einer Antwort wird höchstens eines der Felder festgelegt:
searchParams

object (SearchParams)

Suchparameter
searchResultList

object (SearchResultList)

Suchergebnisliste
Ende der sich gegenseitig ausschließenden Felder.

SearchParams

Suchparameter

JSON-Darstellung 
{
  "maxReturnResults": integer,
  "filter": string,
  "boostSpec": {
    object (BoostSpec)
  },
  "orderBy": string,
  "searchResultMode": enum (SearchResultMode),
  "customFineTuningSpec": {
    object (CustomFineTuningSpec)
  },
  "dataStoreSpecs": [
    {
      object (DataStoreSpec)
    }
  ],
  "naturalLanguageQueryUnderstandingSpec": {
    object (NaturalLanguageQueryUnderstandingSpec)
  }
}
Felder
maxReturnResults

integer

Anzahl der zurückzugebenden Suchergebnisse. Der Standardwert ist 10.
filter

string

Die Filtersyntax besteht aus einer Ausdruckssprache, mit der ein Prädikat aus einem oder mehreren Feldern der gefilterten Dokumente erstellt wird. Bei Filterausdrücken muss die Groß- und Kleinschreibung beachtet werden. Diese werden verwendet, um Suchergebnisse zu filtern, was sich auf die Antwort auswirken kann.

Wenn dieses Feld nicht erkannt wird, wird INVALID_ARGUMENT zurückgegeben.

In Vertex AI Search erfolgt die Filterung durch das Zuordnen des LHS-Filterschlüssels zu einem Schlüsselattribut, das im Vertex AI Search-Backend definiert ist. Diese Zuordnung wird vom Kunden in seinem Schema definiert. Ein Medienkunde hat in seinem Schema beispielsweise das Feld „name“. In diesem Fall würde der Filter so aussehen: filter --> name:'ANY("king kong")'

Weitere Informationen zum Filtern, einschließlich Syntax und Filteroperatoren, finden Sie unter Benutzerdefinierte Suche nach strukturierten oder unstrukturierten Daten filtern.
boostSpec

object (BoostSpec)

Mit der Boost-Spezifikation können Sie bestimmte Dokumente in den Suchergebnissen hervorheben, was sich auf die Antwort auf die Anfrage auswirken kann. Weitere Informationen zum Boosting finden Sie unter Bessere Ergebnisse erzielen.
orderBy

string

Die Reihenfolge, in der Dokumente zurückgegeben werden. Dokumente können nach einem Feld in einem Document-Objekt sortiert werden. Lassen Sie das Feld leer, wenn die Ergebnisse nach Relevanz sortiert werden. Bei orderBy wird die Groß- und Kleinschreibung beachtet. Weitere Informationen zur Reihenfolge

Wenn dieses Feld nicht erkannt wird, wird INVALID_ARGUMENT zurückgegeben.
searchResultMode

enum (SearchResultMode)

Gibt den Modus für Suchergebnisse an. Wenn nichts angegeben ist, wird standardmäßig der Suchergebnismodus DOCUMENTS verwendet. Weitere Informationen finden Sie unter Dokumente parsen und in Blöcke aufteilen.
customFineTuningSpec

object (CustomFineTuningSpec)

Optional. Benutzerdefinierte Konfigurationen für das Fine-Tuning.
dataStoreSpecs[]

object (DataStoreSpec)

Spezifikationen, die Datenspeicher zum Filtern in einem Suchaufruf und Konfigurationen für diese Datenspeicher definieren. Dies wird nur für den Anwendungsfall von Engines mit mehreren Datenspeichern berücksichtigt. Für einen einzelnen Datenspeicher innerhalb einer Engine sollten die Spezifikationen auf der obersten Ebene verwendet werden.
naturalLanguageQueryUnderstandingSpec

object (NaturalLanguageQueryUnderstandingSpec)

Optional. Spezifikation zur Aktivierung von Funktionen zum Verarbeiten natürlicher Sprache für Suchanfragen

SearchResultList

Suchergebnisliste

JSON-Darstellung 
{
  "searchResults": [
    {
      object (SearchResult)
    }
  ]
}
Felder
searchResults[]

object (SearchResult)

Suchergebnisse

SearchResult

Suchergebnis

JSON-Darstellung 
{

  // 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.
}
Felder
Inhalt des Suchergebnisses. Im Folgenden finden Sie eine Liste von sich gegenseitig ausschließenden Feldern. In einer Antwort wird höchstens eines der Felder festgelegt:
unstructuredDocumentInfo

object (UnstructuredDocumentInfo)

Informationen aus unstrukturierten Dokumenten
chunkInfo

object (ChunkInfo)

Informationen zu Blöcken.
Ende der sich gegenseitig ausschließenden Felder.

UnstructuredDocumentInfo

Informationen aus unstrukturierten Dokumenten

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

string

Name der Dokumentressource
uri

string

URI für das Dokument
title

string

Titel:
documentContexts[]

object (DocumentContext)

Liste der Dokumentkontexte. Die Inhalte werden für die Antwortgenerierung verwendet. Dies soll der Hauptinhalt des Dokuments sein, der lang und umfassend sein kann.
extractiveSegments[]

object (ExtractiveSegment)

Liste der extraktiven Segmente
extractiveAnswers[]
(deprecated)

object (ExtractiveAnswer)

Verworfen: Dieses Feld wird nicht mehr unterstützt und hat keine Auswirkungen auf die Antwortgenerierung. Verwenden Sie stattdessen die Felder „documentContexts“ und „extractiveSegments“. Liste der extraktiven Antworten

DocumentContext

Dokumentkontext

JSON-Darstellung 
{
  "pageIdentifier": string,
  "content": string
}
Felder
pageIdentifier

string

Seitenkennung
content

string

Dokumentinhalt, der für die Antwortgenerierung verwendet werden soll

ExtractiveSegment

Extraktives Segment. Anleitung: Die Antwortgenerierung wird nur verwendet, wenn „documentContexts“ leer ist. Es sollten kürzere Snippets sein.

JSON-Darstellung 
{
  "pageIdentifier": string,
  "content": string
}
Felder
pageIdentifier

string

Seitenkennung
content

string

Extraktive Segmentinhalte

ExtractiveAnswer

Extraktive Antwort. Anleitung

JSON-Darstellung 
{
  "pageIdentifier": string,
  "content": string
}
Felder
pageIdentifier

string

Seitenkennung
content

string

Extraktive Antwortinhalte

ChunkInfo

Informationen zu Blöcken.

JSON-Darstellung 
{
  "chunk": string,
  "content": string,
  "documentMetadata": {
    object (DocumentMetadata)
  }
}
Felder
chunk

string

Name der Block-Ressource
content

string

Textinhalt des Blocks
documentMetadata

object (DocumentMetadata)

Metadaten des Dokuments aus dem aktuellen Block

DocumentMetadata

Dokumentmetadaten enthalten die Informationen des Dokuments des aktuellen Blocks.

JSON-Darstellung 
{
  "uri": string,
  "title": string
}
Felder
uri

string

URI des Dokuments
title

string

Titel des Dokuments