---
description: fetching the summary of a Vtuber Fandom page
---

# summary()

```python
Vwiki().summary(vtuber: str, auto_correct: bool = False)

#or

AioVwiki().summary(vtuber: str, auto_correct: bool = False)
```

<details>

<summary>Parameters</summary>

* **vtuber** (_<mark style="color:blue;">str</mark>_) - the vtuber's fandom page to search for
* **auto\_correct** (_<mark style="color:red;">bool</mark>_) - whether or not the `vtuber` query will get auto-corrected (_default: <mark style="color:red;">False</mark>_)

</details>

{% hint style="info" %}
**Note**: it is recommended to turn off `auto`\_`correct` for specific query search
{% endhint %}

<details>

<summary>Returns</summary>

_<mark style="color:blue;">str</mark>_ - a/an paragraph containing the vtuber's summary of the page

</details>

{% hint style="info" %}
**Note**: will returns `"None"` if there is no vtuber's summary of the page
{% endhint %}

## Use Case

{% tabs %}
{% tab title="Async (non-blocking)" %}
Without `auto_correct` :

```python
from vtuberwiki import AioVwiki
import asyncio

async def get_summary():
    async with AioVwiki() as aio_vwiki:
        s = await aio_vwiki.summary(vtuber="mythia batford",auto_correct=False)
        print(s) # No wiki results for Vtuber "mythia batford"
        # Correct one is "Mythia_Batford"

asyncio.run(get_summary()
```

With `auto_correct` :

```python
from vtuberwiki import AioVwiki
import asyncio

async def get_summary():
    async with AioVwiki() as aio_vwiki:
        s = await aio_vwiki.summary(vtuber="mythia batford",auto_correct=True)
        print(s) #Mythia Batford (ミシア ・バットフォード) is an Indonesian female Virtual Youtuber. She uses both Indonesian and English on her stream.
        # it gets auto-corrected to "Mythia_Batford"

asyncio.run(get_summary()
```
{% endtab %}

{% tab title="Sync (blocking)" %}
Without `auto_correct` :

```python
from vtuberwiki import Vwiki

def get_summary():
    vwiki = Vwiki()
    s = vwiki.summary(vtuber="mythia batford",auto_correct=False)
    print(s) # No wiki results for Vtuber "mythia batford"
    
    # Correct one is "Mythia_Batford"

get_summary()
```

With `auto_correct` :

```python
from vtuberwiki import Vwiki

def get_summary():
    vwiki = Vwiki()
    s = vwiki.summary(vtuber="mythia batford",auto_correct=True)
    print(s) # Mythia Batford (ミシア ・バットフォード) is an Indonesian female Virtual Youtuber. 
             # She uses both Indonesian and English on her stream.
    
    # it gets auto-corrected to "Mythia_Batford"

get_summary()
```
{% endtab %}
{% endtabs %}
