ModelSearchParameters
extends BaseSearchParameters
in package
Search for models within the organization linked to the API key.
All search filters are optional. If no search filters are given, all models belonging to the organization are returned.
Results are paginated.
Tags
Table of Contents
Properties
- $modelType : string|null
- $name : string|null
- $page : int|null
- $perPage : int|null
- $slug : string
- $responseClass : ModelSearchResponse>
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
$modelType
public
string|null
$modelType
= null
$name
public
string|null
$name
= null
$page
public
int|null
$page
= null
$perPage
public
int|null
$perPage
= null
$slug
public
static string
$slug
= "models"
Slug of the resource.
$responseClass
protected
static ModelSearchResponse>
$responseClass
= \Mindee\V2\Search\Models\ModelSearchResponse::class
Response class.
Methods
__construct()
public
__construct([string|null $name = null ][, string|null $modelType = null ][, int|null $page = null ][, int|null $perPage = null ]) : mixed
Parameters
- $name : string|null = null
-
Case-insensitive search term for the model name.
- $modelType : string|null = null
-
Case-insensitive search term for the model type.
- $page : int|null = null
-
1-based page index.
- $perPage : int|null = null
-
Number of items per page.
getRequestParameters()
Gets the request parameters for the search request.
public
getRequestParameters() : array<string, string>
Return values
array<string, string> —Query parameters.
getResponseClass()
Gets the response class associated with the parameters.
public
getResponseClass() : TSearchResponse>
Return values
TSearchResponse> —Response class.