Class RagDocumentAnnotationParameters

Annotation parameters for RAG documents.

Hierarchy

BaseAnnotationParameters
- RagDocumentAnnotationParameters

Index

Constructors

Properties

annotation? documentId status?

Methods

getRequestParameters

Constructors

constructor

new RagDocumentAnnotationParameters(
    params: BaseAnnotationParametersConstructor & {
        annotation?: string | Record<string, any> | RagAnnotation | null;
        status?: string;
    },
): RagDocumentAnnotationParameters
Default constructor.
Parameters
- params: BaseAnnotationParametersConstructor & {
  annotation?: string | Record<string, any> | RagAnnotation | null;
  status?: string;
  }
Returns RagDocumentAnnotationParameters
Overrides BaseAnnotationParameters.constructor
- Defined in src/v2/product/extraction/ragDocuments/params/ragDocumentAnnotationParameters.ts:22

Properties

`Optional` `Readonly`annotation

annotation?: RagAnnotation | null

Field-level RAG annotation and guidelines configuration for the document.

`Readonly`documentId

documentId: string

UUID of the annotated document.

`Optional` `Readonly`status

status?: string

New public status to apply to the document (for example, to deactivate it).

Methods

getRequestParameters

getRequestParameters(): Record<string, any>
Gets the request parameters for the upload request.

Returns Record<string, any>
Overrides BaseAnnotationParameters.getRequestParameters
- Defined in src/v2/product/extraction/ragDocuments/params/ragDocumentAnnotationParameters.ts:50