> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cyborg.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Getter Functions

## is\_trained

Returns `True` if the index has been trained, enabling efficient approximate nearest neighbor search. An untrained index will default to exhaustive search.

```python theme={null}
def is_trained(self) -> bool
```

### Returns

`bool`: `True` if the index has been trained; otherwise, `False`.

### Example Usage

```python theme={null}
# Check if index is trained
if index.is_trained():
    print("The index is ready for efficient querying.")
else:
    print("The index is not trained; consider calling train().")
```

***

## index\_name

Retrieves the name of the current index.

```python theme={null}
def index_name(self) -> str
```

### Returns

`str`: Name of the currently loaded or created index.

### Example Usage

```python theme={null}
# Retrieve the index name
print("Current index name:", index.index_name())
```

***

## index\_type

Returns the type of the current index (e.g., `ivf`, `ivfpq`, `ivfflat`).

```python theme={null}
def index_type(self) -> str
```

### Returns

| Return Type | Description                |
| ----------- | -------------------------- |
| `str`       | Type of the current index. |

### Example Usage

```python theme={null}
# Retrieve the type of index
print("Index type:", index.index_type())
```

***

## index\_config

Retrieves the configuration details of the current index.

```python theme={null}
def index_config(self) -> IndexConfig
```

### Returns

[`IndexConfig`](./types#indexconfig): Dictionary of index configuration parameters.

### Example Usage

```python theme={null}
# Retrieve index config
print("Index configuration:", index.index_config())
```