V2 Search
Model Search Parameters
- class ModelSearchParameters(*, page=None, per_page=None, _response_class=<class 'mindee.v2.search.models.model_search_response.ModelSearchResponse'>, name=None, model_type=None)
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.
- Parameters:
page (int | None)
per_page (int | None)
_response_class (type[ModelSearchResponse])
name (str | None)
model_type (str | None)
- get_request_parameters()
Gets the request parameters for the search request.
- Return type:
dict[str,str|list[str]]- Returns:
A dict of parameters.
- get_response_class()
Gets the response class for the search.
- Return type:
type[TypeVar(TypeSearchResponse, bound=BaseSearchResponse)]
- get_slug()
Gets the slug of the resource.
- Return type:
str
- model_type: str | None = None
Filter by an exact model type.
- name: str | None = None
Filter models by partial name match, case-insensitive.
- page: int | None = None
1-based page index.
- per_page: int | None = None
Number of items per page.
Model Search Response
- class ModelSearchResponse(raw_response)
Models search response.
- Parameters:
raw_response (dict[str, Any])
- body_lines()
Lines composing the response-specific body (header + items).
- Return type:
list[str]
- models: SearchModels
Paginated list of matching models.
- pagination: PaginationMetadata
Pagination metadata.
- property raw_http: str
Displays the result of the raw response as json string.
RAG Document Search Parameters
- class RagDocumentSearchParameters(*, page=None, per_page=None, _response_class=<class 'mindee.v2.search.rag_documents.rag_document_search_response.RagDocumentSearchResponse'>, model_id, filename=None)
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.
- Parameters:
page (int | None)
per_page (int | None)
_response_class (type[RagDocumentSearchResponse])
model_id (str)
filename (str | None)
- get_request_parameters()
Gets the request parameters for the search request.
- Return type:
dict[str,str|list[str]]- Returns:
A dict of parameters.
- get_response_class()
Gets the response class for the search.
- Return type:
type[TypeVar(TypeSearchResponse, bound=BaseSearchResponse)]
- get_slug()
Gets the slug of the resource.
- Return type:
str
- filename: str | None = None
Filter documents by partial filename match, case-insensitive.
- model_id: str
The exact Model UUID the document is linked to.
- page: int | None = None
1-based page index.
- per_page: int | None = None
Number of items per page.
RAG Document Search Response
- class RagDocumentSearchResponse(raw_response)
RAG Documents search response.
- Parameters:
raw_response (dict[str, Any])
- body_lines()
Lines composing the response-specific body (header + items).
- Return type:
list[str]
- pagination: PaginationMetadata
Pagination metadata.
- rag_documents: SearchRagDocuments
Paginated list of matching RAG documents.
- property raw_http: str
Displays the result of the raw response as json string.