RagDocumentSearchParameters
extends BaseSearchParameters
in package
Search for RAG documents within the organization linked to the API key.
The model ID is required, search filters are optional. If no search filters are given, all documents linked to the model are returned.
Results are paginated.
Tags
Table of Contents
Properties
- $filename : string|null
- $modelId : string|null
- $page : int|null
- $perPage : int|null
- $slug : string
- $responseClass : RagDocumentSearchResponse>
Methods
- __construct() : mixed
- getRequestParameters() : array<string, string>
- Gets the request parameters for the search request.
- getResponseClass() : TSearchResponse>
- Gets the response class associated with the parameters.
Properties
$filename
public
string|null
$filename
= null
$modelId
public
string|null
$modelId
= null
$page
public
int|null
$page
= null
$perPage
public
int|null
$perPage
= null
$slug
public
static string
$slug
= "rag-documents"
Slug of the resource.
$responseClass
protected
static RagDocumentSearchResponse>
$responseClass
= \Mindee\V2\Search\RagDocuments\RagDocumentSearchResponse::class
Response class.
Methods
__construct()
public
__construct([string|null $modelId = null ][, string|null $filename = null ][, int|null $page = null ][, int|null $perPage = null ]) : mixed
Parameters
- $modelId : string|null = null
-
Model identifier to search in (required).
- $filename : string|null = null
-
Case-insensitive substring search on filename.
- $page : int|null = null
-
1-based page index.
- $perPage : int|null = null
-
Number of result items per page.
getRequestParameters()
Gets the request parameters for the search request.
public
getRequestParameters() : array<string, string>
Tags
Return values
array<string, string> —Query parameters.
getResponseClass()
Gets the response class associated with the parameters.
public
getResponseClass() : TSearchResponse>
Return values
TSearchResponse> —Response class.