Skip to content

Commit bfec36b

Browse files
committed
Documentation update
1 parent 5492d6c commit bfec36b

File tree

13 files changed

+328
-261
lines changed

13 files changed

+328
-261
lines changed

docs/_sources/index.rst.txt

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,15 @@ Actions
3232

3333
user_guide/actions.rst
3434

35+
Privileges
36+
==========
37+
38+
.. toctree::
39+
:numbered:
40+
:maxdepth: 3
41+
42+
user_guide/privileges.rst
43+
3544
Provider
3645
========
3746

docs/_sources/user_guide/installation.rst.txt

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,12 @@ Installation requirements
1111

1212
To use ``select_ai`` you need:
1313

14-
- Python 3.9, 3.10, 3.11, 3.12 or 3.13
14+
- Python 3.9, 3.10, 3.11, 3.12, 3.13 or 3.14
15+
16+
.. warning::
17+
18+
For async APIs, use Python 3.11 or higher. Python 3.11 stabilized the async
19+
event loop management and introduced better-structured APIs
1520

1621
- ``python-oracledb`` - This package is automatically installed as a dependency requirement
1722

@@ -28,7 +33,7 @@ To use ``select_ai`` you need:
2833
`pip <https://pip.pypa.io/en/latest/installation/>`__.
2934

3035
1. Install `Python 3 <https://www.python.org/downloads>`__ if it is not already
31-
available. Use any version from Python 3.9 through 3.13.
36+
available. Use any version from Python 3.9 through 3.14.
3237

3338
2. Install ``select_ai``:
3439

docs/_sources/user_guide/vector_index.rst.txt

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -82,14 +82,13 @@ output::
8282
.. latex:clearpage::
8383
8484
85-
Get vector index attributes
85+
Fetch vector index
8686
+++++++++++++++++++++++++++
8787

8888
You can fetch the vector index attributes and associated AI profile using
89-
``vector_index.get_attributes()`` and ``vector_index.get_profile()`` methods
90-
respectively.
89+
the class method ``VectorIndex.fetch(index_name)``
9190

92-
.. literalinclude:: ../../../samples/vector_index_get_attributes.py
91+
.. literalinclude:: ../../../samples/vector_index_fetch.py
9392
:language: python
9493
:lines: 14-
9594

@@ -196,14 +195,13 @@ output::
196195
.. latex:clearpage::
197196
198197
199-
Async get vector index attributes
198+
Async fetch vector index
200199
+++++++++++++++++++++++++++++++++
201200

202201
You can fetch the vector index attributes and associated AI profile using
203-
``async_vector_index.get_attributes()`` and ``async_vector_index.get_profile()``
204-
methods respectively.
202+
the class method ``AsyncVectorIndex.fetch(index_name)``
205203

206-
.. literalinclude:: ../../../samples/async/vector_index_get_attributes.py
204+
.. literalinclude:: ../../../samples/async/vector_index_fetch.py
207205
:language: python
208206
:lines: 14-
209207

docs/genindex.html

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -411,10 +411,14 @@ <h2 id="F">F</h2>
411411
<li><a href="user_guide/conversation.html#select_ai.AsyncConversation.fetch">(select_ai.AsyncConversation class method)</a>
412412
</li>
413413
<li><a href="user_guide/async_profile.html#select_ai.AsyncProfile.fetch">(select_ai.AsyncProfile class method)</a>
414+
</li>
415+
<li><a href="user_guide/vector_index.html#select_ai.AsyncVectorIndex.fetch">(select_ai.AsyncVectorIndex class method)</a>
414416
</li>
415417
<li><a href="user_guide/conversation.html#select_ai.Conversation.fetch">(select_ai.Conversation class method)</a>
416418
</li>
417419
<li><a href="user_guide/profile.html#select_ai.Profile.fetch">(select_ai.Profile class method)</a>
420+
</li>
421+
<li><a href="user_guide/vector_index.html#select_ai.VectorIndex.fetch">(select_ai.VectorIndex class method)</a>
418422
</li>
419423
</ul></li>
420424
</ul></td>

docs/index.html

Lines changed: 50 additions & 37 deletions
Large diffs are not rendered by default.

docs/objects.inv

7 Bytes
Binary file not shown.

docs/searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/user_guide/agent.html

Lines changed: 33 additions & 33 deletions
Large diffs are not rendered by default.

docs/user_guide/async_agent.html

Lines changed: 66 additions & 54 deletions
Large diffs are not rendered by default.

docs/user_guide/async_profile.html

Lines changed: 40 additions & 40 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)