Module Values.KnowledgeBaseSource

Contains information about a knowledge base.

Sourcetype nonrec t = {
  1. knowledgeBaseId : Id.t option;
    (*

    The unique identifier of the knowledge base.

    *)
  2. name : Name.t option;
    (*

    The name of the knowledge base.

    *)
  3. knowledgeBaseArn : KnowledgeBaseArn.t option;
    (*

    The Amazon Resource Name (ARN) of the knowledge base.

    *)
  4. description : Description.t option;
    (*

    The description of the knowledge base.

    *)
  5. roleArn : KnowledgeBaseRoleArn.t option;
    (*

    The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.

    *)
  6. knowledgeBaseConfiguration : KnowledgeBaseConfiguration.t option;
    (*

    Contains details about the embeddings configuration of the knowledge base.

    *)
  7. storageConfiguration : StorageConfiguration.t option;
    (*

    Contains details about the storage configuration of the knowledge base.

    *)
  8. status : KnowledgeBaseStatus.t option;
    (*

    The status of the knowledge base. The following statuses are possible: CREATING – The knowledge base is being created. ACTIVE – The knowledge base is ready to be queried. DELETING – The knowledge base is being deleted. UPDATING – The knowledge base is being updated. FAILED – The knowledge base API operation failed.

    *)
  9. createdAt : DateTimestamp.t option;
    (*

    The time the knowledge base was created.

    *)
  10. updatedAt : DateTimestamp.t option;
    (*

    The time the knowledge base was last updated.

    *)
  11. failureReasons : FailureReasons.t option;
    (*

    A list of reasons that the API operation on the knowledge base failed.

    *)
}
Sourceval make : ?knowledgeBaseId:??? -> ?name:??? -> ?knowledgeBaseArn:??? -> ?description:??? -> ?roleArn:??? -> ?knowledgeBaseConfiguration:??? -> ?storageConfiguration:??? -> ?status:??? -> ?createdAt:??? -> ?updatedAt:??? -> ?failureReasons:??? -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `List of [> `String of FailureReason.t ] list | `String of Id.t | `Structure of (string * [> `Enum of string | `Structure of (string * [> `Enum of string | `String of BedrockEmbeddingModelArn.t | `Structure of (string * [> `List of [> `Structure of (string * [> `Enum of string | `Structure of (string * [> `List of [> `String of AwsDataCatalogTableName.t ] list | `String of S3BucketUri.t ]) list ]) list ] list | `String of FieldName.t | `Structure of (string * [> `Enum of string | `Integer of Dimensions.t | `List of [> `Structure of (string * [> `Structure of (string * [> `Integer of AudioSegmentationConfigurationFixedLengthDurationInteger.t ]) list ]) list ] list | `Structure of (string * [> `List of [> `Structure of (string * [> `Enum of string | `List of [> `Structure of (string * [> `Enum of string | `String of QueryGenerationColumnName.t ]) list ] list | `String of QueryGenerationTableName.t ]) list ] list | `String of WorkgroupArn.t | `Structure of (string * [> `Enum of string | `String of SecretArn.t ]) list ]) list ]) list ]) list ]) list ]) list | `Timestamp of DateTimestamp.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