LangChain.Tools.DeepResearch.ResearchStatus (LangChain v0.6.0)

Copy Markdown View Source

Represents the status of a Deep Research request.

This schema captures the current state of a research request, including progress information and any errors that may have occurred.

Summary

Types

t()

Functions

changeset(status \\ %__MODULE__{}, attrs)

Creates a changeset for research status.

complete?(arg1)

Checks if the research is complete (either successfully or with failure).

failed?(arg1)

Checks if the research failed.

from_api_response(response)

Creates a ResearchStatus from an OpenAI API response.

status_description(research_status)

Gets a human-readable description of the current status.

successful?(arg1)

Checks if the research completed successfully.

Types

t()

@type t() :: %LangChain.Tools.DeepResearch.ResearchStatus{
  created_at: integer() | nil,
  error_code: String.t() | nil,
  error_message: String.t() | nil,
  id: String.t(),
  progress_info: map() | nil,
  status: String.t()
}

Functions

changeset(status \\ %__MODULE__{}, attrs)

@spec changeset(t(), map()) :: Ecto.Changeset.t()

Creates a changeset for research status.

complete?(arg1)

@spec complete?(t()) :: boolean()

Checks if the research is complete (either successfully or with failure).

failed?(arg1)

@spec failed?(t()) :: boolean()

Checks if the research failed.

from_api_response(response)

@spec from_api_response(map()) :: {:ok, t()} | {:error, Ecto.Changeset.t()}

Creates a ResearchStatus from an OpenAI API response.

status_description(research_status)

@spec status_description(t()) :: String.t()

Gets a human-readable description of the current status.

successful?(arg1)

@spec successful?(t()) :: boolean()

Checks if the research completed successfully.