Refactors index functions

[alexthomas93]

Description

This PR refactors the code for interacting with vector and hybrid indexes. Key changes include:

• Refactors get_search_query to make it compatible with LangChain Neo4j.
• Adds retrieve_fulltext_index_info utility function: Retrieves metadata about existing full-text indexes.
• Adds retrieve_vector_index_info utility function: Retrieves metadata about existing vector indexes.
• Adds the effective_search_ratio parameter for vector and hybrid search.

Type of Change

• New feature
• Bug fix
• Breaking change
• Documentation update
• Project configuration change

Complexity

Complexity: Medium

How Has This Been Tested?

• Unit tests
• E2E tests
• Manual tests

Checklist

The following requirements should have been met (depending on the changes in the branch):

• Documentation has been updated
• Unit tests have been updated
• E2E tests have been updated
• Examples have been updated
• New files have copyright header
• CLA (https://neo4j.com/developer/cla/) has been signed
• CHANGELOG.md updated if appropriate

[willtai]

Deprecates the id property returned by all retrievers.

This will be a breaking change. Why do we make this change in this PR?

[alexthomas93]

Deprecates the id property returned by all retrievers.

This will be a breaking change. Why do we make this change in this PR?

We don't necessarily. Happy to remove it and make the change in another PR. It just felt like given I was already refactoring these functions now might be a good time to do it. I think there have also been a few releases now since the warning this property would be removed was added.

[alexthomas93]

@CodiumAI-Agent /update_changelog

[CodiumAI-Agent]

Changelog updates: 🔄

2025-02-12 *

Added

• Utility functions to retrieve metadata for vector and full-text indexes.
• Support for effective_search_ratio parameter in vector and hybrid searches.

Changed

• Refactored index-related functions for improved compatibility and functionality.
• Deprecated the id property in retriever results.

to commit the new content to the CHANGELOG.md file, please type:
'/update_changelog --pr_update_changelog.push_changelog_changes=true'

[willtai]

We don't necessarily. Happy to remove it and make the change in another PR. It just felt like given I was already refactoring these functions now might be a good time to do it. I think there have also been a few releases now since the warning this property would be removed was added.

Don't think we need it for this PR. We can remove it in a separate PR, wdyt?

[CodiumAI-Agent]

Changelog updates: 🔄

2025-02-13

Added

• Utility functions to retrieve metadata for vector and full-text indexes.
• Support for effective_search_ratio parameter in vector and hybrid searches.

Changed

• Refactored index-related functions for improved compatibility and functionality.
• Deprecated the id property in retriever results.

to commit the new content to the CHANGELOG.md file, please type:
'/update_changelog --pr_update_changelog.push_changelog_changes=true'

[alexthomas93]

We don't necessarily. Happy to remove it and make the change in another PR. It just felt like given I was already refactoring these functions now might be a good time to do it. I think there have also been a few releases now since the warning this property would be removed was added.

Don't think we need it for this PR. We can remove it in a separate PR, wdyt?

Makes sense. I'll add something to the backlog to remind us to deprecate it at some point in the future. Have re-added it in e773de4. PR should no longer have any breaking changes in it.

[willtai]

☄️