Home / Class/ DeleteResponse Class — langchain Architecture

DeleteResponse Class — langchain Architecture

Architecture documentation for the DeleteResponse class in base.py from the langchain codebase.

Entity Profile

Dependency Diagram

graph TD
  18d18d7e_96fb_9281_c303_5c47c9564a17["DeleteResponse"]
  44ffc3da_66a5_f9ca_57ac_f9a80e82f0c8["base.py"]
  18d18d7e_96fb_9281_c303_5c47c9564a17 -->|defined in| 44ffc3da_66a5_f9ca_57ac_f9a80e82f0c8

Relationship Graph

Source Code

libs/core/langchain_core/indexing/base.py lines 460–493

class DeleteResponse(TypedDict, total=False):
    """A generic response for delete operation.

    The fields in this response are optional and whether the `VectorStore`
    returns them or not is up to the implementation.
    """

    num_deleted: int
    """The number of items that were successfully deleted.

    If returned, this should only include *actual* deletions.

    If the ID did not exist to begin with,
    it should not be included in this count.
    """

    succeeded: Sequence[str]
    """The IDs that were successfully deleted.

    If returned, this should only include *actual* deletions.

    If the ID did not exist to begin with,
    it should not be included in this list.
    """

    failed: Sequence[str]
    """The IDs that failed to be deleted.

    !!! warning
        Deleting an ID that does not exist is **NOT** considered a failure.
    """

    num_failed: int
    """The number of items that failed to be deleted."""

Frequently Asked Questions

What is the DeleteResponse class?
DeleteResponse is a class in the langchain codebase, defined in libs/core/langchain_core/indexing/base.py.
Where is DeleteResponse defined?
DeleteResponse is defined in libs/core/langchain_core/indexing/base.py at line 460.

Analyze Your Own Codebase

Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.

Try Supermodel Free