SearchResult

Stellt die Suchergebnisse dar.

JSON-Darstellung 
{
  "id": string,
  "document": {
    object (Document)
  },
  "chunk": {
    object (Chunk)
  },
  "modelScores": {
    string: {
      object (DoubleList)
    },
    ...
  },
  "rankSignals": {
    object (RankSignals)
  }
}
Felder
id

string

Document.id der gesuchten Document.
document

object (Document)

Das Dokumentdaten-Snippet in der Suchantwort. Nur Felder, die als retrievable markiert sind, werden ausgefüllt.
chunk

object (Chunk)

Die Chunk-Daten in der Suchantwort, wenn SearchRequest.ContentSearchSpec.search_result_mode auf CHUNKS gesetzt ist.
modelScores

map (key: string, value: object (DoubleList))

Nur Ausgabe. Google hat verfügbare Bewertungen bereitgestellt.
rankSignals

object (RankSignals)

Optional. Eine Reihe von Ranking-Signalen, die dem Ergebnis zugeordnet sind.

Chunk

Im Chunk werden alle Rohmetadateninformationen von Elementen erfasst, die im Chunk-Modus empfohlen oder gesucht werden sollen.

JSON-Darstellung 
{
  "name": string,
  "id": string,
  "content": string,
  "documentMetadata": {
    object (DocumentMetadata)
  },
  "derivedStructData": {
    object
  },
  "pageSpan": {
    object (PageSpan)
  },
  "chunkMetadata": {
    object (ChunkMetadata)
  },
  "dataUrls": [
    string
  ],
  "annotationContents": [
    string
  ],
  "annotationMetadata": [
    {
      object (AnnotationMetadata)
    }
  ],
  "relevanceScore": number
}
Felder
name

string

Der vollständige Ressourcenname des Chunks. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}/documents/{documentId}/chunks/{chunk_id}.

Dieses Feld muss ein UTF-8-codierter String mit einer Längenbeschränkung von 1.024 Zeichen sein.
id

string

Eindeutige Chunk-ID des aktuellen Chunks.
content

string

„Inhalt“ ist ein String aus einem Dokument (geparster Inhalt).
documentMetadata

object (DocumentMetadata)

Metadaten des Dokuments aus dem aktuellen Chunk.
derivedStructData

object (Struct format)

Nur Ausgabe. Dieses Feld dient nur der Ausgabe. Es enthält abgeleitete Daten, die nicht im ursprünglichen Eingabedokument enthalten sind.
pageSpan

object (PageSpan)

Seitenbereich des Blocks.
chunkMetadata

object (ChunkMetadata)

Nur Ausgabe. Metadaten des aktuellen Chunks.
dataUrls[]

string

Nur Ausgabe. Bilddaten-URLs, wenn der aktuelle Chunk Bilder enthält. Data-URLs bestehen aus vier Teilen: einem Präfix (data:), einem MIME-Typ, der den Datentyp angibt, einem optionalen base64-Token, wenn die Daten nicht textbasiert sind, und den Daten selbst: data:[][;base64],
annotationContents[]

string

Nur Ausgabe. Inhalt der Anmerkungen, wenn der aktuelle Chunk Anmerkungen enthält.
annotationMetadata[]

object (AnnotationMetadata)

Nur Ausgabe. Die Metadaten der Anmerkung enthalten strukturierte Inhalte im aktuellen Chunk.
relevanceScore

number

Nur Ausgabe. Stellt die Relevanzbewertung basierend auf der Ähnlichkeit dar. Ein höherer Wert weist auf eine höhere Relevanz des Chunks hin. Der Wert liegt im Bereich [-1,0, 1,0]. Wird nur für SearchResponse ausgefüllt.

DocumentMetadata

Dokumentmetadaten enthalten die Informationen des Dokuments des aktuellen Chunks.

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

string

URI des Dokuments.
title

string

Titel des Dokuments.
mimeType

string

Der MIME-Typ des Dokuments. https://www.iana.org/assignments/media-types/media-types.xhtml.
structData

object (Struct format)

Datendarstellung Die strukturierten JSON-Daten für das Dokument. Sie muss der registrierten Schema entsprechen, andernfalls wird ein INVALID_ARGUMENT-Fehler ausgegeben.

PageSpan

Seitenbereich des Blocks.

JSON-Darstellung 
{
  "pageStart": integer,
  "pageEnd": integer
}
Felder
pageStart

integer

Die Startseite des Chunks.
pageEnd

integer

Die Endseite des Chunks.

ChunkMetadata

Metadaten des aktuellen Chunks. Dieses Feld wird nur in der SearchService.Search API ausgefüllt.

JSON-Darstellung 
{
  "previousChunks": [
    {
      object (Chunk)
    }
  ],
  "nextChunks": [
    {
      object (Chunk)
    }
  ]
}
Felder
previousChunks[]

object (Chunk)

Die vorherigen Chunks des aktuellen Chunks. Die Nummer wird von SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks verwaltet. Dieses Feld wird nur in der SearchService.Search API ausgefüllt.
nextChunks[]

object (Chunk)

Die nächsten Chunks des aktuellen Chunks. Die Nummer wird von SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks verwaltet. Dieses Feld wird nur in der SearchService.Search API ausgefüllt.

AnnotationMetadata

Die Metadaten der Anmerkung enthalten strukturierte Inhalte im aktuellen Chunk.

JSON-Darstellung 
{
  "structuredContent": {
    object (StructuredContent)
  },
  "imageId": string
}
Felder
structuredContent

object (StructuredContent)

Nur Ausgabe. Informationen zu strukturierten Inhalten.
imageId

string

Nur Ausgabe. Die Bild-ID wird angegeben, wenn die strukturierten Inhalte auf einem Bild basieren.

StructuredContent

Informationen zu strukturierten Inhalten.

JSON-Darstellung 
{
  "structureType": enum (StructureType),
  "content": string
}
Felder
structureType

enum (StructureType)

Nur Ausgabe. Der Strukturtyp des strukturierten Inhalts.
content

string

Nur Ausgabe. Der Inhalt der strukturierten Inhalte.

StructureType

Definiert die Typen der strukturierten Inhalte, die extrahiert werden können.

Enums
STRUCTURE_TYPE_UNSPECIFIED Standardwert.
SHAREHOLDER_STRUCTURE Aktionärsstruktur.
SIGNATURE_STRUCTURE Signaturstruktur.
CHECKBOX_STRUCTURE Kästchenstruktur.

DoubleList

Doppelte Liste.

JSON-Darstellung 
{
  "values": [
    number
  ]
}
Felder
values[]

number

Double-Werte.

RankSignals

Eine Reihe von Ranking-Signalen.

JSON-Darstellung 
{
  "defaultRank": number,
  "customSignals": [
    {
      object (CustomSignal)
    }
  ],
  "keywordSimilarityScore": number,
  "relevanceScore": number,
  "semanticSimilarityScore": number,
  "pctrRank": number,
  "topicalityRank": number,
  "documentAge": number,
  "boostingFactor": number
}
Felder
defaultRank

number

Optional. Der Standardrang des Ergebnisses.
customSignals[]

object (CustomSignal)

Optional. Eine Liste benutzerdefinierter Clearbox-Signale.
keywordSimilarityScore

number

Optional. Anpassung der Keyword-Optionen
relevanceScore

number

Optional. Anpassung der semantischen Relevanz.
semanticSimilarityScore

number

Optional. Anpassung der semantischen Ähnlichkeit.
pctrRank

number

Optional. Prognostizierte Anpassung der Conversion-Rate als Rang.
topicalityRank

number

Optional. Anpassung der Aktualität als Rang.
documentAge

number

Optional. Alter des Dokuments in Stunden.
boostingFactor

number

Optional. Kombinierte benutzerdefinierte Steigerungen für ein Dokument.

CustomSignal

Benutzerdefiniertes Clearbox-Signal, das durch ein Name/Wert-Paar dargestellt wird.

JSON-Darstellung 
{
  "name": string,
  "value": number
}
Felder
name

string

Optional. Name des Signals.
value

number

Optional. Gleitkommawert, der das Ranking-Signal darstellt (z. B. 1,25 für BM25).