LangChain Reference home pageLangChain ReferenceLangChain Reference
  • GitHub
  • Main Docs
Deep Agents
LangChain
LangGraph
Integrations
LangSmith
  • Overview
  • Client
  • AsyncClient
  • Run Helpers
  • Run Trees
  • Evaluation
  • Schemas
  • Utilities
  • Wrappers
  • Anonymizer
  • Testing
  • Expect API
  • Middleware
  • Pytest Plugin
  • Deployment SDK
⌘I

LangChain Assistant

Ask a question to get started

Enter to send•Shift+Enter new line

Menu

OverviewClientAsyncClientRun HelpersRun TreesEvaluationSchemasUtilitiesWrappersAnonymizerTestingExpect APIMiddlewarePytest PluginDeployment SDK
Language
Theme
Pythonlangsmith_openapi_clientresourcesdatasetscomparative
Module●Since v0.9

comparative

Attributes

Functions

Classes

Modules

View source on GitHub
attribute
Body: object
attribute
Query: Mapping[str, object]
attribute
Headers: Mapping[str, Union[str, Omit]]
attribute
omit
attribute
not_given
function
path_template
function
maybe_transform
function
async_maybe_transform
function
to_raw_response_wrapper
function
to_streamed_response_wrapper
function
async_to_raw_response_wrapper
function
async_to_streamed_response_wrapper
function
make_request_options
class
Omit
class
NotGiven
class
SequenceNotStr
class
SyncAPIResource
class
AsyncAPIResource
class
ComparativeCreateResponse
class
ComparativeResource
class
AsyncComparativeResource
class
ComparativeResourceWithRawResponse
class
AsyncComparativeResourceWithRawResponse
class
ComparativeResourceWithStreamingResponse
class
AsyncComparativeResourceWithStreamingResponse
module
comparative_create_params

Interpolate {name} placeholders in template from keyword arguments.

Wrapper over transform() that allows None to be passed.

See transform() for more details.

Wrapper over async_transform() that allows None to be passed.

See async_transform() for more details.

Higher order function that takes one of our bound API methods and wraps it to support returning the raw APIResponse object directly.

Higher order function that takes one of our bound API methods and wraps it to support streaming and returning the raw APIResponse object directly.

Higher order function that takes one of our bound API methods and wraps it to support returning the raw APIResponse object directly.

Higher order function that takes one of our bound API methods and wraps it to support streaming and returning the raw APIResponse object directly.

Create a dict of type RequestOptions without keys of NotGiven values.

ComparativeExperiment schema.

To explicitly omit something from being sent in a request, use omit.

# as the default `Content-Type` header is `application/json` that will be sent
client.post("/upload/files", files={"file": b"my raw file content"})

# you can't explicitly override the header as it has to be dynamically generated
# to look something like: 'multipart/form-data; boundary=0d8382fcf5f8c3be01ca2e11002d2983'
client.post(..., headers={"Content-Type": "multipart/form-data"})

# instead you can remove the default `application/json` header by passing omit
client.post(..., headers={"Content-Type": omit})

For parameters with a meaningful None value, we need to distinguish between the user explicitly passing None, and the user not passing the parameter at all.

User code shouldn't need to use not_given directly.

For example:

def create(timeout: Timeout | None | NotGiven = not_given): ...

create(timeout=1)  # 1s timeout
create(timeout=None)  # No timeout
create()  # Default timeout behavior