## Query Retrievers

`RetrieverListPaginatedPageResponse Retrievers.ListPaginated(RetrieverListPaginatedParams?parameters, CancellationTokencancellationToken = default)`

**get** `/api/v1/beta/retrievers`

List the retrievers in a project, newest first.

### Parameters

- `RetrieverListPaginatedParams parameters`

  - `Boolean includeTotal`

    Return `total_size`, a count of every row matching the filter. It is a second query on every page, so it is off unless asked for.

  - `string? name`

  - `string? organizationID`

  - `Long pageSize`

    Number of items per page

  - `string? pageToken`

    Cursor from the previous page's `next_page_token`.

  - `string? projectID`

### Returns

- `class RetrieverListPaginatedPageResponse:`

  A page of retrievers.

  - `required IReadOnlyList<Retriever> Items`

    The list of items.

    - `required string ID`

      Unique identifier

    - `required string Name`

      A name for the retriever tool. Will default to the pipeline name if not provided.

    - `required string ProjectID`

      The ID of the project this retriever resides in.

    - `DateTimeOffset? CreatedAt`

      Creation datetime

    - `IReadOnlyList<RetrieverPipeline> Pipelines`

      The pipelines this retriever uses.

      - `required string? Description`

        A description of the retriever tool.

      - `required string? Name`

        A name for the retriever tool. Will default to the pipeline name if not provided.

      - `required string PipelineID`

        The ID of the pipeline this tool uses.

      - `PresetRetrievalParams PresetRetrievalParameters`

        Parameters for retrieval configuration.

        - `Double? Alpha`

          Alpha value for hybrid retrieval to determine the weights between dense and sparse retrieval. 0 is sparse retrieval and 1 is dense retrieval.

        - `string ClassName`

        - `Double? DenseSimilarityCutoff`

          Minimum similarity score wrt query for retrieval

        - `Long? DenseSimilarityTopK`

          Number of nodes for dense retrieval.

        - `Boolean? EnableReranking`

          Enable reranking for retrieval

        - `Long? FilesTopK`

          Number of files to retrieve (only for retrieval mode files_via_metadata and files_via_content).

        - `Long? RerankTopN`

          Number of reranked nodes for returning.

        - `RetrievalMode RetrievalMode`

          The retrieval mode for the query.

          - `"auto_routed"AutoRouted`

          - `"chunks"Chunks`

          - `"files_via_content"FilesViaContent`

          - `"files_via_metadata"FilesViaMetadata`

        - `Boolean RetrieveImageNodes`

          Whether to retrieve image nodes.

        - `Boolean RetrievePageFigureNodes`

          Whether to retrieve page figure nodes.

        - `Boolean RetrievePageScreenshotNodes`

          Whether to retrieve page screenshot nodes.

        - `MetadataFilters? SearchFilters`

          Metadata filters for vector stores.

          - `required IReadOnlyList<Filter> Filters`

            - `class MetadataFilter:`

              Comprehensive metadata filter for vector stores to support more operators.

              Value uses Strict types, as int, float and str are compatible types and were all
              converted to string before.

              See: https://docs.pydantic.dev/latest/usage/types/#strict-types

              - `required string Key`

              - `required Value? Value`

                - `Double`

                - `string`

                - `IReadOnlyList<string>`

                - `IReadOnlyList<Double>`

                - `IReadOnlyList<Long>`

              - `Operator Operator`

                Vector store filter operator.

                - `"!="`

                - `"<"`

                - `"<="`

                - `"=="`

                - `">"`

                - `">="`

                - `"all"All`

                - `"any"Any`

                - `"contains"Contains`

                - `"in"In`

                - `"is_empty"IsEmpty`

                - `"nin"Nin`

                - `"text_match"TextMatch`

                - `"text_match_insensitive"TextMatchInsensitive`

            - `class MetadataFilters:`

              Metadata filters for vector stores.

          - `Condition? Condition`

            Vector store filter conditions to combine different filters.

            - `"and"And`

            - `"not"Not`

            - `"or"Or`

        - `IReadOnlyDictionary<string, SearchFiltersInferenceSchema?>? SearchFiltersInferenceSchema`

          JSON Schema that will be used to infer search_filters. Omit or leave as null to skip inference.

          - `IReadOnlyDictionary<string, JsonElement>`

          - `IReadOnlyList<JsonElement>`

          - `string`

          - `Double`

          - `Boolean`

        - `Long? SparseSimilarityTopK`

          Number of nodes for sparse retrieval.

    - `DateTimeOffset? UpdatedAt`

      Update datetime

  - `string? NextPageToken`

    A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

  - `Long? TotalSize`

    The total number of items available. This is only populated when specifically requested. The value may be an estimate and can be used for display purposes only.

### Example

```csharp
RetrieverListPaginatedParams parameters = new();

var page = await client.Retrievers.ListPaginated(parameters);
await foreach (var item in page.Paginate())
{
    Console.WriteLine(item);
}
```

#### Response

```json
{
  "items": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "name": "x",
      "project_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "created_at": "2019-12-27T18:11:19.117Z",
      "pipelines": [
        {
          "description": "description",
          "name": "x",
          "pipeline_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "preset_retrieval_parameters": {
            "alpha": 0,
            "class_name": "class_name",
            "dense_similarity_cutoff": 0,
            "dense_similarity_top_k": 1,
            "enable_reranking": true,
            "files_top_k": 1,
            "rerank_top_n": 1,
            "retrieval_mode": "auto_routed",
            "retrieve_image_nodes": true,
            "retrieve_page_figure_nodes": true,
            "retrieve_page_screenshot_nodes": true,
            "search_filters": {
              "filters": [
                {
                  "key": "key",
                  "value": 0,
                  "operator": "!="
                }
              ],
              "condition": "and"
            },
            "search_filters_inference_schema": {
              "foo": {
                "foo": "bar"
              }
            },
            "sparse_similarity_top_k": 1
          }
        }
      ],
      "updated_at": "2019-12-27T18:11:19.117Z"
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}
```