DocumentChunk

import type { DocumentChunk } from "https://googleapis.deno.dev/v1/developerknowledge:v1.ts";

A DocumentChunk represents a piece of content from a Document in the DeveloperKnowledge corpus. To fetch the entire document content, pass the parent to DeveloperKnowledge.GetDocument or DeveloperKnowledge.BatchGetDocuments.

interface DocumentChunk {

readonly content?: string;

readonly document?: Document;

readonly id?: string;

readonly parent?: string;

}

§Properties

readonly content?: string

[src]

Output only. Contains the content of the document chunk.

readonly document?: Document

[src]

Output only. Represents metadata about the Document this chunk is from. The DocumentView of this Document message will be set to DOCUMENT_VIEW_BASIC. It is included here for convenience so that clients do not need to call DeveloperKnowledge.GetDocument or DeveloperKnowledge.BatchGetDocuments if they only need the metadata fields. Otherwise, clients should use DeveloperKnowledge.GetDocument or DeveloperKnowledge.BatchGetDocuments to fetch the full document content.

readonly id?: string

[src]

Output only. Specifies the ID of this chunk within the document. The chunk ID is unique within a document, but not globally unique across documents. The chunk ID is not stable and may change over time.

readonly parent?: string

[src]

Output only. Contains the resource name of the document this chunk is from. Format: documents/{uri_without_scheme} Example: documents/docs.cloud.google.com/storage/docs/creating-buckets