View Source GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaChunk (google_api_discovery_engine v0.27.0)

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

Attributes

  • chunkMetadata (type: GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaChunkChunkMetadata.t, default: nil) - Output only. Metadata of the current chunk.
  • content (type: String.t, default: nil) - Content is a string from a document (parsed content).
  • derivedStructData (type: map(), default: nil) - Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.
  • documentMetadata (type: GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaChunkDocumentMetadata.t, default: nil) - Metadata of the document from the current chunk.
  • id (type: String.t, default: nil) - Unique chunk ID of the current chunk.
  • name (type: String.t, default: nil) - 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.
  • pageSpan (type: GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaChunkPageSpan.t, default: nil) - Page span of the chunk.
  • relevanceScore (type: float(), default: nil) - 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.

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
  %GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaChunk{
    chunkMetadata:
      GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaChunkChunkMetadata.t()
      | nil,
    content: String.t() | nil,
    derivedStructData: map() | nil,
    documentMetadata:
      GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaChunkDocumentMetadata.t()
      | nil,
    id: String.t() | nil,
    name: String.t() | nil,
    pageSpan:
      GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaChunkPageSpan.t()
      | nil,
    relevanceScore: float() | nil
  }

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.