Module Values.DocumentBlockSource

A document to include in a message.

Sourcetype nonrec t = {
  1. format : DocumentFormat.t option;
    (*

    The format of a document, or its extension.

    *)
  2. name : DocumentBlockNameString.t;
    (*

    A name for the document. The name can only contain the following characters: Alphanumeric characters Whitespace characters (no more than one in a row) Hyphens Parentheses Square brackets This field is vulnerable to prompt injections, because the model might inadvertently interpret it as instructions. Therefore, we recommend that you specify a neutral name.

    *)
  3. source : DocumentSource.t;
    (*

    Contains the content of the document.

    *)
  4. context : String_.t option;
    (*

    Contextual information about how the document should be processed or interpreted by the model when generating citations.

    *)
  5. citations : CitationsConfig.t option;
    (*

    Configuration settings that control how citations should be generated for this specific document.

    *)
}
Sourceval context_ : string
Sourceval make : ?format:??? -> ?context:??? -> ?citations:??? -> name:DocumentBlockNameString.t -> source:DocumentSource.t -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `String of DocumentBlockNameString.t | `Structure of (string * [> `Blob of DocumentSourceBytesBlob.t | `Boolean of Boolean.t | `List of [> `Structure of (string * [> `String of String_.t ]) list ] list | `String of String_.t | `Structure of (string * [> `String of S3Uri.t ]) list ]) list ]) 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