> ## 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

```cpp theme={null}
bool is_trained() const;
```

Returns whether the index has been trained.

***

## index\_name

```cpp theme={null}
std::string index_name() const;
```

Returns the name of the index.

***

## index\_type

```cpp theme={null}
IndexType index_type() const;
```

Returns the type of the index (for example, IVF, IVFPQ, or IVFFlat).

***

## index\_config

```cpp theme={null}
IndexConfig* index_config() const;
```

Returns a pointer to the index configuration.