RagDocumentAnnotationParameters
extends BaseAnnotationParameters
in package
Annotation parameters for RAG documents.
Tags
Table of Contents
Properties
- $annotation : RagAnnotation|null
- $documentId : string
- $status : string|null
- $responseClass : ExtractionRagAnnotationResponse>
Methods
- __construct() : mixed
- getRequestParameters() : array<string, mixed>
- Gets the request parameters for the upload request.
- getResponseClass() : TAnnotationResponse>
- Gets the response class associated with the parameters.
Properties
$annotation
public
RagAnnotation|null
$annotation
Field-level RAG annotation and guidelines configuration for the document.
$documentId read-only
public
string
$documentId
$status
public
string|null
$status
= null
$responseClass
protected
static ExtractionRagAnnotationResponse>
$responseClass
= \Mindee\V2\Product\Extraction\RagDocuments\ExtractionRagAnnotationResponse::class
Response class.
Methods
__construct()
public
__construct(string $documentId[, string|null $status = null ][, string|RagAnnotation|null $annotation = null ]) : mixed
Parameters
- $documentId : string
-
Unique identifier of the document.
- $status : string|null = null
-
New public status to apply to the document.
- $annotation : string|RagAnnotation|null = null
-
RAG annotation as an object or JSON string.
Tags
getRequestParameters()
Gets the request parameters for the upload request.
public
getRequestParameters() : array<string, mixed>
Tags
Return values
array<string, mixed> —Request parameters.
getResponseClass()
Gets the response class associated with the parameters.
public
getResponseClass() : TAnnotationResponse>
Return values
TAnnotationResponse> —Response class.