# `LangChain.Tools.DeepResearch.ResearchStatus`
[🔗](https://github.com/brainlid/langchain/blob/v0.13.0/lib/tools/deep_research/research_status.ex#L1)

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.

# `t`
[🔗](https://github.com/brainlid/langchain/blob/v0.13.0/lib/tools/deep_research/research_status.ex#L11)

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

# `changeset`
[🔗](https://github.com/brainlid/langchain/blob/v0.13.0/lib/tools/deep_research/research_status.ex#L37)

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

Creates a changeset for research status.

# `complete?`
[🔗](https://github.com/brainlid/langchain/blob/v0.13.0/lib/tools/deep_research/research_status.ex#L71)

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

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

# `failed?`
[🔗](https://github.com/brainlid/langchain/blob/v0.13.0/lib/tools/deep_research/research_status.ex#L89)

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

Checks if the research failed.

# `from_api_response`
[🔗](https://github.com/brainlid/langchain/blob/v0.13.0/lib/tools/deep_research/research_status.ex#L48)

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

Creates a ResearchStatus from an OpenAI API response.

# `status_description`
[🔗](https://github.com/brainlid/langchain/blob/v0.13.0/lib/tools/deep_research/research_status.ex#L99)

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

Gets a human-readable description of the current status.

# `successful?`
[🔗](https://github.com/brainlid/langchain/blob/v0.13.0/lib/tools/deep_research/research_status.ex#L82)

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

Checks if the research completed successfully.

---

*Consult [api-reference.md](api-reference.md) for complete listing*