# VertexAISearchRetriever

> **Class** in `langchain_google_community`

📖 [View in docs](https://reference.langchain.com/python/langchain-google-community/vertex_ai_search/VertexAISearchRetriever)

`Google Vertex AI Search` retriever.

This retriever supports both stable (v1) and beta versions of the Discovery Engine.

Beta features are only available when `beta=True`.

For a detailed explanation of Vertex AI Search concepts and configuration parameters
see the [Vertex AI Search documentation](https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction).

## Signature

```python
VertexAISearchRetriever(
    self,
    kwargs: Any = {},
)
```

## Extends

- `BaseRetriever`
- `_BaseVertexAISearchRetriever`

## Constructors

```python
__init__(
    self,
    kwargs: Any = {},
) -> None
```

| Name | Type |
|------|------|
| `kwargs` | `Any` |


## Properties

- `filter`
- `order_by`
- `canonical_filter`
- `get_extractive_answers`
- `max_documents`
- `max_extractive_answer_count`
- `max_extractive_segment_count`
- `return_extractive_segment_score`
- `num_previous_segments`
- `num_next_segments`
- `query_expansion_condition`
- `spell_correction_mode`
- `boost_spec`
- `custom_embedding`
- `custom_embedding_field_path`
- `custom_embedding_ratio`

---

[View source on GitHub](https://github.com/langchain-ai/langchain-google/blob/bd712d49ef6534a6170aebe1fcb97c9b695b144a/libs/community/langchain_google_community/vertex_ai_search.py#L280)