Interface EventSearchSummary.Builder

  • Method Details

    • eventId

      The ID of the event that the chunk belongs to. Use it with GetEvent or DeleteEvent.

      Parameters:
      eventId - The ID of the event that the chunk belongs to. Use it with GetEvent or DeleteEvent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • score

      The relevance score of the result. A higher score is more relevant. Scores aren't normalized to a fixed range and can be greater than 1, so use them only to order results.

      Parameters:
      score - The relevance score of the result. A higher score is more relevant. Scores aren't normalized to a fixed range and can be greater than 1, so use them only to order results.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • systemMetadata

      EventSearchSummary.Builder systemMetadata(SystemMetadata systemMetadata)

      Provenance for the chunk: the owning actor and session, and when it was created and last updated. It is the same block that ListMemories and SearchMemories return. Event chunks are never modified, so updatedAt always equals createdAt.

      Absent when the service has no provenance for the chunk.

      Parameters:
      systemMetadata - Provenance for the chunk: the owning actor and session, and when it was created and last updated. It is the same block that ListMemories and SearchMemories return. Event chunks are never modified, so updatedAt always equals createdAt.

      Absent when the service has no provenance for the chunk.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • systemMetadata

      default EventSearchSummary.Builder systemMetadata(Consumer<SystemMetadata.Builder> systemMetadata)

      Provenance for the chunk: the owning actor and session, and when it was created and last updated. It is the same block that ListMemories and SearchMemories return. Event chunks are never modified, so updatedAt always equals createdAt.

      Absent when the service has no provenance for the chunk.

      This is a convenience method that creates an instance of the SystemMetadata.Builder avoiding the need to create one manually via SystemMetadata.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to systemMetadata(SystemMetadata).

      Parameters:
      systemMetadata - a consumer that will call methods on SystemMetadata.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • metadata

      The event's metadata tags. All values are strings. In a query, filter on a tag as metadata.<key>.

      Parameters:
      metadata - The event's metadata tags. All values are strings. In a query, filter on a tag as metadata.<key>.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • matchedContent

      EventSearchSummary.Builder matchedContent(String matchedContent)

      The text of the matching chunk.

      Parameters:
      matchedContent - The text of the matching chunk.
      Returns:
      Returns a reference to this object so that method calls can be chained together.