SearchSpec

Spezifikation der Suche.

JSON-Darstellung 
{

  // 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.
}
Felder
Union-Feld input. Suchparameter zum Steuern des Suchverhaltens. Oder geben Sie eine Liste mit Suchergebnissen an, um eine Antwort zu generieren. Für input ist nur einer der folgenden Werte zulässig:
searchParams

object (SearchParams)

Suchparameter
searchResultList

object (SearchResultList)

Suchergebnisliste.

SearchParams

Suchparameter

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

integer

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

string

Die Filtersyntax besteht aus einer Ausdruckssprache zum Erstellen eines Prädikats aus einem oder mehreren Feldern der gefilterten Dokumente. Bei Filterausdrücken wird zwischen Groß- und Kleinschreibung unterschieden. 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.

Das Filtern in Vertex AI Search erfolgt durch Zuordnen des LHS-Filterschlüssels zu einer Schlüsselattribut, das im Vertex AI Search-Backend definiert ist. Diese Zuordnung wird vom Kunden in seinem Schema definiert. Ein Media-Kunde 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 Filter.
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 Boosten finden Sie unter Boost.
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 sollen. Bei orderBy wird zwischen Groß- und Kleinschreibung unterschieden. Weitere Informationen zur Bestellung finden Sie unter Bestellen.

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. Dokumente parsen und in Chunks aufteilen
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 DataStores berücksichtigt. Für einen einzelnen Datenspeicher innerhalb einer Engine sollten die Spezifikationen auf der obersten Ebene verwendet werden.

SearchResultList

Suchergebnisliste.

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

object (SearchResult)

Suchergebnisse.

SearchResult

Suchergebnis.

JSON-Darstellung 
{

  // 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.
}
Felder
Union-Feld content. Inhalte der Suchergebnisse. Für content ist nur einer der folgenden Werte zulässig:
unstructuredDocumentInfo

object (UnstructuredDocumentInfo)

Informationen aus unstrukturierten Dokumenten.
chunkInfo

object (ChunkInfo)

Informationen zu Chunks.

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 ist veraltet 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

Seiten-ID.
content

string

Dokumentinhalt, der für die Antwortgenerierung verwendet werden soll.

ExtractiveSegment

Extrahierendes Segment. Guide: Die Antwortgenerierung wird nur verwendet, wenn „documentContexts“ leer ist. Es sollen kürzere Ausschnitte sein.

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

string

Seiten-ID.
content

string

Extrahierte Segmentinhalte.

ExtractiveAnswer

Extraktive Antwort. Leitfaden

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

string

Seiten-ID.
content

string

Inhalte extraktiver Antworten.

ChunkInfo

Informationen zu Chunks.

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

string

Name der Chunk-Ressource.
content

string

Textinhalte in Abschnitte unterteilen
documentMetadata

object (DocumentMetadata)

Metadaten des Dokuments aus dem aktuellen Chunk.

DocumentMetadata

Dokumentmetadaten enthalten die Informationen des Dokuments des aktuellen Chunks.

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

string

URI des Dokuments.
title

string

Titel des Dokuments.