Detail View

This module contains views to implement the Vectorsearch.

card-style detail view in the Smarter Dashboard.

class smarter.apps.vectorsearch.views.detailview.VectorsearchDetailView(**kwargs)[source]

Bases: DocsBaseView

Renders the detail view for a Smarter dashboard vectorsearch.

This view renders a detailed manifest for a specific vectorsearch, including its configuration and metadata, in YAML format. It is intended for authenticated users and provides error handling for missing or unsupported vectorsearch kinds and names.

Parameters:

  • request (ASGIRequest) – Django HTTP request object.

  • args (tuple) – Additional positional arguments.

  • kwargs (dict) – Keyword arguments, must include ‘name’ (vectorsearch name) and ‘kind’ (vectorsearch type).

Returns:

Rendered HTML page with vectorsearch manifest details, or a 404 error page if the vectorsearch is not found or parameters are invalid.

Return type:

HttpResponse

Note

The vectorsearch name and kind must be provided and valid. Otherwise, a “not found” response is returned.

See also

Vectorsearch for vectorsearch metadata retrieval. ApiV1CliDescribeApiView for API details.

Example usage:

GET /vectorsearch/detail/?name=my_vectorsearch&kind=custom
get(request, *args, **kwargs)[source]

Handle GET requests to render the vectorsearch manifest detail view.

This method processes the incoming request to retrieve the specified vectorsearch’s manifest details and renders them in a user-friendly format. It performs validation on the provided vectorsearch name and kind, retrieves the vectorsearch metadata, and handles any errors that may arise during this process.

Process: 1. Extract and validate ‘name’ and ‘kind’ from kwargs. 2. Retrieve the vectorsearch metadata using the provided name and user context. 3. If the vectorsearch is found, call the API view to get the vectorsearch details 4. Convert the JSON response to YAML format for better readability. 5. Render the vectorsearch manifest detail template with the retrieved data. 6. Handle any errors that occur during the process and return appropriate error responses.

Parameters:

  • request (ASGIRequest) – Django HTTP request object.

  • args (tuple) – Additional positional arguments.

  • kwargs (dict) – Keyword arguments, must include ‘name’ (vectorsearch name) and ‘kind’ (vectorsearch type).

Returns:

Rendered HTML page with vectorsearch manifest details, or an error response if the vectorsearch is not found or parameters are invalid.

Return type:

HttpResponse

template_path: str | None = 'common/manifest_detail.html'
vectorsearch: Vectorsearch | None = None