Show / Hide Table of Contents

Class GoogleCloudDiscoveryengineV1alphaChunk

Chunk captures all raw metadata information of items to be recommended or searched in the chunk mode.

Inheritance
object
GoogleCloudDiscoveryengineV1alphaChunk
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.DiscoveryEngine.v1alpha.Data
Assembly: Google.Apis.DiscoveryEngine.v1alpha.dll
Syntax
public class GoogleCloudDiscoveryengineV1alphaChunk : IDirectResponseSchema

Properties

AnnotationContents

Output only. Annotation contents if the current chunk contains annotations.

Declaration
[JsonProperty("annotationContents")]
public virtual IList<string> AnnotationContents { get; set; }
Property Value
Type Description
IList<string>

AnnotationMetadata

Output only. The annotation metadata includes structured content in the current chunk.

Declaration
[JsonProperty("annotationMetadata")]
public virtual IList<GoogleCloudDiscoveryengineV1alphaChunkAnnotationMetadata> AnnotationMetadata { get; set; }
Property Value
Type Description
IList<GoogleCloudDiscoveryengineV1alphaChunkAnnotationMetadata>

ChunkMetadata

Output only. Metadata of the current chunk.

Declaration
[JsonProperty("chunkMetadata")]
public virtual GoogleCloudDiscoveryengineV1alphaChunkChunkMetadata ChunkMetadata { get; set; }
Property Value
Type Description
GoogleCloudDiscoveryengineV1alphaChunkChunkMetadata

Content

Content is a string from a document (parsed content).

Declaration
[JsonProperty("content")]
public virtual string Content { get; set; }
Property Value
Type Description
string

DataUrls

Output only. Image Data URLs if the current chunk contains images. Data URLs are composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:,

Declaration
[JsonProperty("dataUrls")]
public virtual IList<string> DataUrls { get; set; }
Property Value
Type Description
IList<string>

DerivedStructData

Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.

Declaration
[JsonProperty("derivedStructData")]
public virtual IDictionary<string, object> DerivedStructData { get; set; }
Property Value
Type Description
IDictionary<string, object>

DocumentMetadata

Metadata of the document from the current chunk.

Declaration
[JsonProperty("documentMetadata")]
public virtual GoogleCloudDiscoveryengineV1alphaChunkDocumentMetadata DocumentMetadata { get; set; }
Property Value
Type Description
GoogleCloudDiscoveryengineV1alphaChunkDocumentMetadata

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

Id

Unique chunk ID of the current chunk.

Declaration
[JsonProperty("id")]
public virtual string Id { get; set; }
Property Value
Type Description
string

Name

The full resource name of the chunk. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk_id}. This field must be a UTF-8 encoded string with a length limit of 1024 characters.

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

PageSpan

Page span of the chunk.

Declaration
[JsonProperty("pageSpan")]
public virtual GoogleCloudDiscoveryengineV1alphaChunkPageSpan PageSpan { get; set; }
Property Value
Type Description
GoogleCloudDiscoveryengineV1alphaChunkPageSpan

RelevanceScore

Output only. Represents the relevance score based on similarity. Higher score indicates higher chunk relevance. The score is in range [-1.0, 1.0]. Only populated on SearchResponse.

Declaration
[JsonProperty("relevanceScore")]
public virtual double? RelevanceScore { get; set; }
Property Value
Type Description
double?

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX