Class DocumentBlock

Inheritance
object
ContentBlock
DocumentBlock
Inherited Members
Namespace: Glitch9.AIDevKit.AmazonAws
Assembly: Glitch9.AIDevKit.Provider.AmazonAws.dll
Syntax
public sealed class DocumentBlock : ContentBlock

Properties

| Edit this page View Source

Citations

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

Declaration
[JsonProperty("citations")]
public CitationsConfiguration Citations { get; set; }
Property Value
Type Description
CitationsConfiguration
| Edit this page View Source

Context

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

Declaration
[JsonProperty("context")]
public string Context { get; set; }
Property Value
Type Description
string
| Edit this page View Source

Format

Optional. The format of a document, or its extension.

Declaration
[JsonProperty("format")]
public string Format { get; set; }
Property Value
Type Description
string
Remarks

Valid Values: pdf | csv | doc | docx | xls | xlsx | html | txt | md

| Edit this page View Source

Name

Required. A name for the document. The name can only contain alphanumeric characters, whitespace (no more than one in a row), hyphens, parentheses, and square brackets. Note: 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.

Declaration
[JsonProperty("name")]
public string Name { get; set; }
Property Value
Type Description
string
| Edit this page View Source

Source

Required. Contains the content of the document.

Declaration
[JsonProperty("source")]
public DocumentBlock.DocumentSource Source { get; set; }
Property Value
Type Description
DocumentBlock.DocumentSource

Methods

| Edit this page View Source

Base64(string, string, string)

Declaration
public static DocumentBlock Base64(string base64Data, string name, string format = null)
Parameters
Type Name Description
string base64Data
string name
string format
Returns
Type Description
DocumentBlock
| Edit this page View Source

S3(string, string, string, string)

Declaration
public static DocumentBlock S3(string s3Uri, string name, string format = null, string bucketOwner = null)
Parameters
Type Name Description
string s3Uri
string name
string format
string bucketOwner
Returns
Type Description
DocumentBlock

Extension Methods