ApiRetriever

class ansys.fluent.mcp.solve.catalog.retriever.ApiRetriever

Bases: abc.ABC

ABC for an API retriever. Async by convention.

Overview

Abstract methods

retrieve

Retrieve API hits that match the query and filters.

Methods

aclose

Close resources for the ApiRetriever object.

Attributes

name

Import detail

from ansys.fluent.mcp.solve.catalog.retriever import ApiRetriever

Attribute detail

ApiRetriever.name: str = 'abstract'

Method detail

abstractmethod ApiRetriever.retrieve(query: str, *, top_k: int = 10, kinds: Sequence[str] | None = None, under: str | None = None) → list[ApiHit]

Async:

Retrieve API hits that match the query and filters.

Parameters:

querystr

Search text or user request to evaluate.

top_kint

Maximum number of results to return.

kindsOptional[Sequence[str]]

Optional result kinds used to narrow the operation.

underOptional[str]

Optional path prefix used to scope the operation.

Returns:

list[ApiHit]

List of results produced by the operation.

async ApiRetriever.aclose() → None

Close resources for the ApiRetriever object.

Returns:

None

The function completes through its side effects.