REST Resource: projects.locations.dataStores.branches.documents.chunks

Ressource: 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.

Methoden

get

 Erstellt einen Document.

list

 Ruft eine Liste von Chunk ab.