Class RagDocumentSearchParameters

Search parameters for RAG Documents.

Hierarchy

BaseSearchParameters
- RagDocumentSearchParameters

Index

Constructors

Properties

filename? modelId page? perPage?

Methods

getRequestParameters

Constructors

constructor

new RagDocumentSearchParameters(
params: RagDocumentSearchParametersConstructor,
): v2.search.RagDocumentSearchParameters
Parameters
- params: RagDocumentSearchParametersConstructor
Returns v2.search.RagDocumentSearchParameters
Overrides BaseSearchParameters.constructor
- Defined in src/v2/search/ragDocuments/ragDocumentSearchParameters.ts:26

Properties

`Optional`filename

filename?: string

Case-insensitive substring search on filename.

modelId

modelId: string

Model identifier to search in.

`Optional`page

page?: number

1-based page index.

`Optional`perPage

perPage?: number

Number of items per page.

Methods

getRequestParameters

getRequestParameters(): Record<string, string>
Returns Record<string, string>

Inherit Doc
Overrides BaseSearchParameters.getRequestParameters
- Defined in src/v2/search/ragDocuments/ragDocumentSearchParameters.ts:36