Up – Package index » awso » Library awso.bedrock » Awso_bedrock » Values » MetadataAttributeSchema

Module `Values.MetadataAttributeSchema`Source

Defines the schema for a metadata attribute used in Knowledge Base vector searches. Metadata attributes provide additional context for documents and can be used for filtering and reranking search results.

Sourcetype nonrec t = {

key : MetadataAttributeSchemaKeyString.t;
(*
The unique identifier for the metadata attribute. This key is used to reference the attribute in filter expressions and reranking configurations.
*)
type_ : AttributeType.t;
(*
The data type of the metadata attribute. The type determines how the attribute can be used in filter expressions and reranking.
*)
description : MetadataAttributeSchemaDescriptionString.t;
(*
An optional description of the metadata attribute that provides additional context about its purpose and usage.
*)

}

Sourceval context_ : string

Source

val make : 
  key:MetadataAttributeSchemaKeyString.t ->
  type_:AttributeType.t ->
  description:MetadataAttributeSchemaDescriptionString.t ->
  unit ->
  t

Source

val to_value : 
  t ->
  [> `Structure of
       (string
        * [> `Enum of string | `String of MetadataAttributeSchemaKeyString.t ])
         list ]

Sourceval to_query : t -> Awso.Client.Query.t

Sourceval of_xml : Awso.Xml.t -> t

Sourceval of_string : string -> t

Sourceval of_json : Yojson.Safe.t -> t

Sourceval to_json : t -> Yojson.Safe.t