Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,15 @@ Actions

user_guide/actions.rst

Privileges
==========

.. toctree::
:numbered:
:maxdepth: 3

user_guide/privileges.rst

Provider
========

Expand Down
9 changes: 7 additions & 2 deletions doc/source/user_guide/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,12 @@ Installation requirements

To use ``select_ai`` you need:

- Python 3.9, 3.10, 3.11, 3.12 or 3.13
- Python 3.9, 3.10, 3.11, 3.12, 3.13 or 3.14

.. warning::

For async APIs, use Python 3.11 or higher. Python 3.11 stabilized the async
event loop management and introduced better-structured APIs

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

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

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

2. Install ``select_ai``:

Expand Down
14 changes: 6 additions & 8 deletions doc/source/user_guide/vector_index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -82,14 +82,13 @@ output::
.. latex:clearpage::


Get vector index attributes
Fetch vector index
+++++++++++++++++++++++++++

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

.. literalinclude:: ../../../samples/vector_index_get_attributes.py
.. literalinclude:: ../../../samples/vector_index_fetch.py
:language: python
:lines: 14-

Expand Down Expand Up @@ -196,14 +195,13 @@ output::
.. latex:clearpage::


Async get vector index attributes
Async fetch vector index
+++++++++++++++++++++++++++++++++

You can fetch the vector index attributes and associated AI profile using
``async_vector_index.get_attributes()`` and ``async_vector_index.get_profile()``
methods respectively.
the class method ``AsyncVectorIndex.fetch(index_name)``

.. literalinclude:: ../../../samples/async/vector_index_get_attributes.py
.. literalinclude:: ../../../samples/async/vector_index_fetch.py
:language: python
:lines: 14-

Expand Down
9 changes: 9 additions & 0 deletions docs/_sources/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,15 @@ Actions

user_guide/actions.rst

Privileges
==========

.. toctree::
:numbered:
:maxdepth: 3

user_guide/privileges.rst

Provider
========

Expand Down
9 changes: 7 additions & 2 deletions docs/_sources/user_guide/installation.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,12 @@ Installation requirements

To use ``select_ai`` you need:

- Python 3.9, 3.10, 3.11, 3.12 or 3.13
- Python 3.9, 3.10, 3.11, 3.12, 3.13 or 3.14

.. warning::

For async APIs, use Python 3.11 or higher. Python 3.11 stabilized the async
event loop management and introduced better-structured APIs

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

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

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

2. Install ``select_ai``:

Expand Down
14 changes: 6 additions & 8 deletions docs/_sources/user_guide/vector_index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -82,14 +82,13 @@ output::
.. latex:clearpage::


Get vector index attributes
Fetch vector index
+++++++++++++++++++++++++++

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

.. literalinclude:: ../../../samples/vector_index_get_attributes.py
.. literalinclude:: ../../../samples/vector_index_fetch.py
:language: python
:lines: 14-

Expand Down Expand Up @@ -196,14 +195,13 @@ output::
.. latex:clearpage::


Async get vector index attributes
Async fetch vector index
+++++++++++++++++++++++++++++++++

You can fetch the vector index attributes and associated AI profile using
``async_vector_index.get_attributes()`` and ``async_vector_index.get_profile()``
methods respectively.
the class method ``AsyncVectorIndex.fetch(index_name)``

.. literalinclude:: ../../../samples/async/vector_index_get_attributes.py
.. literalinclude:: ../../../samples/async/vector_index_fetch.py
:language: python
:lines: 14-

Expand Down
4 changes: 4 additions & 0 deletions docs/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -411,10 +411,14 @@ <h2 id="F">F</h2>
<li><a href="user_guide/conversation.html#select_ai.AsyncConversation.fetch">(select_ai.AsyncConversation class method)</a>
</li>
<li><a href="user_guide/async_profile.html#select_ai.AsyncProfile.fetch">(select_ai.AsyncProfile class method)</a>
</li>
<li><a href="user_guide/vector_index.html#select_ai.AsyncVectorIndex.fetch">(select_ai.AsyncVectorIndex class method)</a>
</li>
<li><a href="user_guide/conversation.html#select_ai.Conversation.fetch">(select_ai.Conversation class method)</a>
</li>
<li><a href="user_guide/profile.html#select_ai.Profile.fetch">(select_ai.Profile class method)</a>
</li>
<li><a href="user_guide/vector_index.html#select_ai.VectorIndex.fetch">(select_ai.VectorIndex class method)</a>
</li>
</ul></li>
</ul></td>
Expand Down
Loading