id stringlengths 14 16 | text stringlengths 13 2.7k | source stringlengths 57 178 |
|---|---|---|
d8c216c9cf77-1 | Return type
ApifyDatasetLoader
async acall_actor_task(task_id: str, task_input: Dict, dataset_mapping_function: Callable[[Dict], Document], *, build: Optional[str] = None, memory_mbytes: Optional[int] = None, timeout_secs: Optional[int] = None) → ApifyDatasetLoader[source]¶
Run a saved Actor task on Apify and wait for ... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.apify.ApifyWrapper.html |
d8c216c9cf77-2 | :type run_input: Dict
:param dataset_mapping_function: A function that takes a single
dictionary (an Apify dataset item) and converts it to an
instance of the Document class.
Parameters
build (str, optional) – Optionally specifies the actor build to run.
It can be either a build tag or build number.
memory_mbytes (int,... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.apify.ApifyWrapper.html |
d8c216c9cf77-3 | Return type
ApifyDatasetLoader
classmethod construct(_fields_set: Optional[SetStr] = None, **values: Any) → Model¶
Creates a new model setting __dict__ and __fields_set__ from trusted or pre-validated data.
Default values are respected, but no other validation is performed.
Behaves as if Config.extra = ‘allow’ was set ... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.apify.ApifyWrapper.html |
d8c216c9cf77-4 | classmethod from_orm(obj: Any) → Model¶
json(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, by_alias: bool = False, skip_defaults: Optional[bool] = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_n... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.apify.ApifyWrapper.html |
84b49a245ab5-0 | langchain.utilities.vertexai.init_vertexai¶
langchain.utilities.vertexai.init_vertexai(project: Optional[str] = None, location: Optional[str] = None, credentials: Optional[Credentials] = None) → None[source]¶
Init vertexai.
Parameters
project – The default GCP project to use when making Vertex API calls.
location – The... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.vertexai.init_vertexai.html |
9bdbc5d2bd69-0 | langchain.utilities.clickup.Member¶
class langchain.utilities.clickup.Member(id: int, username: str, email: str, initials: str)[source]¶
Component class for a member.
Attributes
id
username
email
initials
Methods
__init__(id, username, email, initials)
from_data(data)
__init__(id: int, username: str, email: str, initia... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.clickup.Member.html |
4e3b2afc24f8-0 | langchain.utilities.zapier.ZapierNLAWrapper¶
class langchain.utilities.zapier.ZapierNLAWrapper[source]¶
Bases: BaseModel
Wrapper for Zapier NLA.
Full docs here: https://nla.zapier.com/start/
This wrapper supports both API Key and OAuth Credential auth methods. API Key
is the fastest way to get started using this wrappe... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.zapier.ZapierNLAWrapper.html |
4e3b2afc24f8-1 | }]
params will always contain an instructions key, the only required
param. All others optional and if provided will override any AI guesses
(see “understanding the AI guessing flow” here:
https://nla.zapier.com/api/v1/docs)
async alist_as_str() → str[source]¶
Same as list, but returns a stringified version of the JSON... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.zapier.ZapierNLAWrapper.html |
4e3b2afc24f8-2 | Default values are respected, but no other validation is performed.
Behaves as if Config.extra = ‘allow’ was set since it adds all passed values
copy(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, update: Optional[DictStrAny... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.zapier.ZapierNLAWrapper.html |
4e3b2afc24f8-3 | classmethod from_orm(obj: Any) → Model¶
json(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, by_alias: bool = False, skip_defaults: Optional[bool] = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_n... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.zapier.ZapierNLAWrapper.html |
4e3b2afc24f8-4 | classmethod parse_obj(obj: Any) → Model¶
classmethod parse_raw(b: Union[str, bytes], *, content_type: unicode = None, encoding: unicode = 'utf8', proto: Protocol = None, allow_pickle: bool = False) → Model¶
preview(action_id: str, instructions: str, params: Optional[Dict] = None) → Dict[source]¶
Same as run, but instea... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.zapier.ZapierNLAWrapper.html |
4e3b2afc24f8-5 | Try to update ForwardRefs on fields based on this Model, globalns and localns.
classmethod validate(value: Any) → Model¶
Examples using ZapierNLAWrapper¶
Zapier Natural Language Actions | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.zapier.ZapierNLAWrapper.html |
e7ba515370d9-0 | langchain.utilities.vertexai.raise_vertex_import_error¶
langchain.utilities.vertexai.raise_vertex_import_error(minimum_expected_version: str = '1.35.0') → None[source]¶
Raise ImportError related to Vertex SDK being not available.
Parameters
minimum_expected_version – The lowest expected version of the SDK.
Raises
Impor... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.vertexai.raise_vertex_import_error.html |
d72628a95b60-0 | langchain.utilities.searx_search.SearxResults¶
class langchain.utilities.searx_search.SearxResults(data: str)[source]¶
Dict like wrapper around search api results.
Take a raw result from Searx and make it into a dict like object.
Attributes
answers
Helper accessor on the json result.
results
Silence mypy for accessing ... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.searx_search.SearxResults.html |
d72628a95b60-1 | copy() → a shallow copy of D¶
fromkeys(value=None, /)¶
Create a new dictionary with keys from iterable and values set to value.
get(key, default=None, /)¶
Return the value for key if key is in the dictionary, else default.
items() → a set-like object providing a view on D's items¶
keys() → a set-like object providing a... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.searx_search.SearxResults.html |
1f37c033c62f-0 | langchain.utilities.github.GitHubAPIWrapper¶
class langchain.utilities.github.GitHubAPIWrapper[source]¶
Bases: BaseModel
Wrapper for GitHub API.
Create a new model by parsing and validating input data from keyword arguments.
Raises ValidationError if the input data cannot be parsed to form a valid model.
param github_a... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.github.GitHubAPIWrapper.html |
1f37c033c62f-1 | exclude – fields to exclude from new model, as with values this takes precedence over include
update – values to change/add in the new model. Note: the data is not validated before creating
the new model: you should trust this data
deep – set to True to make a deep copy of the model
Returns
new model instance
create_fi... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.github.GitHubAPIWrapper.html |
1f37c033c62f-2 | Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.
classmethod from_orm(obj: Any) → Model¶
get_issue(issue_number: int) → Dict[str, Any][source]¶
Fetches a specific issue and its first 10 comments
:param issue_number: The number for the github issue
:type issue_... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.github.GitHubAPIWrapper.html |
1f37c033c62f-3 | :type issues: List[Issue]
Returns
A dictionary of issue titles and numbers
Return type
List[dict]
classmethod parse_obj(obj: Any) → Model¶
classmethod parse_raw(b: Union[str, bytes], *, content_type: unicode = None, encoding: unicode = 'utf8', proto: Protocol = None, allow_pickle: bool = False) → Model¶
read_file(file_... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.github.GitHubAPIWrapper.html |
2dc352e9ea14-0 | langchain.utilities.gitlab.GitLabAPIWrapper¶
class langchain.utilities.gitlab.GitLabAPIWrapper[source]¶
Bases: BaseModel
Wrapper for GitLab API.
Create a new model by parsing and validating input data from keyword arguments.
Raises ValidationError if the input data cannot be parsed to form a valid model.
param gitlab_b... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.gitlab.GitLabAPIWrapper.html |
2dc352e9ea14-1 | Behaves as if Config.extra = ‘allow’ was set since it adds all passed values
copy(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, update: Optional[DictStrAny] = None, deep: bool = False) → Model¶
Duplicate a model, optionally... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.gitlab.GitLabAPIWrapper.html |
2dc352e9ea14-2 | :type file_path: str
Returns
Success or failure message
Return type
str
dict(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, by_alias: bool = False, skip_defaults: Optional[bool] = None, exclude_unset: bool = False, exclude_d... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.gitlab.GitLabAPIWrapper.html |
2dc352e9ea14-3 | classmethod parse_file(path: Union[str, Path], *, content_type: unicode = None, encoding: unicode = 'utf8', proto: Protocol = None, allow_pickle: bool = False) → Model¶
parse_issues(issues: List[Issue]) → List[dict][source]¶
Extracts title and number from each Issue and puts them in a dictionary
:param issues: A list o... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.gitlab.GitLabAPIWrapper.html |
2dc352e9ea14-4 | NEW <<<<
Hello Mars!
>>>> NEW
Returns
A success or failure message
classmethod update_forward_refs(**localns: Any) → None¶
Try to update ForwardRefs on fields based on this Model, globalns and localns.
classmethod validate(value: Any) → Model¶
Examples using GitLabAPIWrapper¶
Gitlab | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.gitlab.GitLabAPIWrapper.html |
564809938d74-0 | langchain.utilities.pubmed.PubMedAPIWrapper¶
class langchain.utilities.pubmed.PubMedAPIWrapper[source]¶
Bases: BaseModel
Wrapper around PubMed API.
This wrapper will use the PubMed API to conduct searches and fetch
document summaries. By default, it will return the document summaries
of the top-k results of an input se... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.pubmed.PubMedAPIWrapper.html |
564809938d74-1 | Default values are respected, but no other validation is performed.
Behaves as if Config.extra = ‘allow’ was set since it adds all passed values
copy(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, update: Optional[DictStrAny... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.pubmed.PubMedAPIWrapper.html |
564809938d74-2 | classmethod from_orm(obj: Any) → Model¶
json(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, by_alias: bool = False, skip_defaults: Optional[bool] = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_n... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.pubmed.PubMedAPIWrapper.html |
564809938d74-3 | Run PubMed search and get the article meta information.
See https://www.ncbi.nlm.nih.gov/books/NBK25499/#chapter4.ESearch
It uses only the most informative fields of article meta information.
classmethod schema(by_alias: bool = True, ref_template: unicode = '#/definitions/{model}') → DictStrAny¶
classmethod schema_json... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.pubmed.PubMedAPIWrapper.html |
aa851b9aa29e-0 | langchain.utilities.redis.get_client¶
langchain.utilities.redis.get_client(redis_url: str, **kwargs: Any) → RedisType[source]¶
Get a redis client from the connection url given. This helper accepts
urls for Redis server (TCP with/without TLS or UnixSocket) as well as
Redis Sentinel connections.
Redis Cluster is not supp... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.redis.get_client.html |
4b6a72bc5f1c-0 | langchain.utilities.clickup.extract_dict_elements_from_component_fields¶
langchain.utilities.clickup.extract_dict_elements_from_component_fields(data: dict, component: Type[Component]) → dict[source]¶
Extract elements from a dictionary.
Parameters
data – The dictionary to extract elements from.
component – The componen... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.clickup.extract_dict_elements_from_component_fields.html |
642e6c6936c9-0 | langchain.utilities.arcee.ArceeWrapper¶
class langchain.utilities.arcee.ArceeWrapper(arcee_api_key: str, arcee_api_url: str, arcee_api_version: str, model_kwargs: Optional[Dict[str, Any]], model_name: str)[source]¶
Wrapper for Arcee API.
Initialize ArceeWrapper.
Parameters
arcee_api_key – API key for Arcee API.
arcee_a... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.arcee.ArceeWrapper.html |
642e6c6936c9-1 | filters – Filters to apply to the context dataset.
retrieve(query: str, **kwargs: Any) → List[Document][source]¶
Retrieve {size} contexts with your retriever for a given query
Parameters
query – Query to submit to the model
size – The max number of context results to retrieve. Defaults to 3.
(Can be less if filters are... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.arcee.ArceeWrapper.html |
d306b5f6dad5-0 | langchain.utilities.arcee.ArceeDocument¶
class langchain.utilities.arcee.ArceeDocument[source]¶
Bases: BaseModel
Arcee document.
Create a new model by parsing and validating input data from keyword arguments.
Raises ValidationError if the input data cannot be parsed to form a valid model.
param id: str [Required]¶
para... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.arcee.ArceeDocument.html |
d306b5f6dad5-1 | deep – set to True to make a deep copy of the model
Returns
new model instance
dict(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, by_alias: bool = False, skip_defaults: Optional[bool] = None, exclude_unset: bool = False, ex... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.arcee.ArceeDocument.html |
d306b5f6dad5-2 | classmethod schema(by_alias: bool = True, ref_template: unicode = '#/definitions/{model}') → DictStrAny¶
classmethod schema_json(*, by_alias: bool = True, ref_template: unicode = '#/definitions/{model}', **dumps_kwargs: Any) → unicode¶
classmethod update_forward_refs(**localns: Any) → None¶
Try to update ForwardRefs on... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.arcee.ArceeDocument.html |
9060ed13ccd3-0 | langchain.utilities.graphql.GraphQLAPIWrapper¶
class langchain.utilities.graphql.GraphQLAPIWrapper[source]¶
Bases: BaseModel
Wrapper around GraphQL API.
To use, you should have the gql python package installed.
This wrapper will use the GraphQL API to conduct queries.
Create a new model by parsing and validating input ... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.graphql.GraphQLAPIWrapper.html |
9060ed13ccd3-1 | deep – set to True to make a deep copy of the model
Returns
new model instance
dict(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, by_alias: bool = False, skip_defaults: Optional[bool] = None, exclude_unset: bool = False, ex... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.graphql.GraphQLAPIWrapper.html |
9060ed13ccd3-2 | run(query: str) → str[source]¶
Run a GraphQL query and get the results.
classmethod schema(by_alias: bool = True, ref_template: unicode = '#/definitions/{model}') → DictStrAny¶
classmethod schema_json(*, by_alias: bool = True, ref_template: unicode = '#/definitions/{model}', **dumps_kwargs: Any) → unicode¶
classmethod ... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.graphql.GraphQLAPIWrapper.html |
362f095afe57-0 | langchain.utilities.arcee.ArceeRoute¶
class langchain.utilities.arcee.ArceeRoute(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
Routes available for the Arcee API as enumerator.
generate = 'models/generate'¶
retrieve = 'models/retrieve'¶
model_training_status = 'models/sta... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.arcee.ArceeRoute.html |
a25de96e4ea9-0 | langchain_experimental.utilities.python.PythonREPL¶
class langchain_experimental.utilities.python.PythonREPL[source]¶
Bases: BaseModel
Simulates a standalone Python REPL.
Create a new model by parsing and validating input data from keyword arguments.
Raises ValidationError if the input data cannot be parsed to form a v... | lang/api.python.langchain.com/en/latest/utilities/langchain_experimental.utilities.python.PythonREPL.html |
a25de96e4ea9-1 | deep – set to True to make a deep copy of the model
Returns
new model instance
dict(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, by_alias: bool = False, skip_defaults: Optional[bool] = None, exclude_unset: bool = False, ex... | lang/api.python.langchain.com/en/latest/utilities/langchain_experimental.utilities.python.PythonREPL.html |
a25de96e4ea9-2 | run(command: str, timeout: Optional[int] = None) → str[source]¶
Run command with own globals/locals and returns anything printed.
Timeout after the specified number of seconds.
classmethod schema(by_alias: bool = True, ref_template: unicode = '#/definitions/{model}') → DictStrAny¶
classmethod schema_json(*, by_alias: b... | lang/api.python.langchain.com/en/latest/utilities/langchain_experimental.utilities.python.PythonREPL.html |
0540c8df4d9c-0 | langchain.utilities.requests.Requests¶
class langchain.utilities.requests.Requests[source]¶
Bases: BaseModel
Wrapper around requests to handle auth and async.
The main purpose of this wrapper is to handle authentication (by saving
headers) and enable easy async methods on the same base object.
Create a new model by par... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.requests.Requests.html |
0540c8df4d9c-1 | Default values are respected, but no other validation is performed.
Behaves as if Config.extra = ‘allow’ was set since it adds all passed values
copy(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, update: Optional[DictStrAny... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.requests.Requests.html |
0540c8df4d9c-2 | GET the URL and return the text.
json(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, by_alias: bool = False, skip_defaults: Optional[bool] = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bo... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.requests.Requests.html |
0540c8df4d9c-3 | classmethod schema_json(*, by_alias: bool = True, ref_template: unicode = '#/definitions/{model}', **dumps_kwargs: Any) → unicode¶
classmethod update_forward_refs(**localns: Any) → None¶
Try to update ForwardRefs on fields based on this Model, globalns and localns.
classmethod validate(value: Any) → Model¶
Examples usi... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.requests.Requests.html |
82ff844c6ed8-0 | langchain.utilities.requests.TextRequestsWrapper¶
class langchain.utilities.requests.TextRequestsWrapper[source]¶
Bases: BaseModel
Lightweight wrapper around requests library.
The main purpose of this wrapper is to always return a text output.
Create a new model by parsing and validating input data from keyword argumen... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.requests.TextRequestsWrapper.html |
82ff844c6ed8-1 | Behaves as if Config.extra = ‘allow’ was set since it adds all passed values
copy(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, update: Optional[DictStrAny] = None, deep: bool = False) → Model¶
Duplicate a model, optionally... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.requests.TextRequestsWrapper.html |
82ff844c6ed8-2 | GET the URL and return the text.
json(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, by_alias: bool = False, skip_defaults: Optional[bool] = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bo... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.requests.TextRequestsWrapper.html |
82ff844c6ed8-3 | classmethod schema_json(*, by_alias: bool = True, ref_template: unicode = '#/definitions/{model}', **dumps_kwargs: Any) → unicode¶
classmethod update_forward_refs(**localns: Any) → None¶
Try to update ForwardRefs on fields based on this Model, globalns and localns.
classmethod validate(value: Any) → Model¶
property req... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.requests.TextRequestsWrapper.html |
0a36fec64932-0 | langchain.utilities.arcee.ArceeDocumentAdapter¶
class langchain.utilities.arcee.ArceeDocumentAdapter[source]¶
Adapter for Arcee documents
Methods
__init__()
adapt(arcee_document)
Adapts an ArceeDocument to a langchain's Document object.
__init__()¶
classmethod adapt(arcee_document: ArceeDocument) → Document[source]¶
Ad... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.arcee.ArceeDocumentAdapter.html |
6ddac03f1f4a-0 | langchain.utilities.searx_search.SearxSearchWrapper¶
class langchain.utilities.searx_search.SearxSearchWrapper[source]¶
Bases: BaseModel
Wrapper for Searx API.
To use you need to provide the searx host by passing the named parameter
searx_host or exporting the environment variable SEARX_HOST.
In some situations you mig... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.searx_search.SearxSearchWrapper.html |
6ddac03f1f4a-1 | Asynchronously query with json results.
Uses aiohttp. See results for more info.
async arun(query: str, engines: Optional[List[str]] = None, query_suffix: Optional[str] = '', **kwargs: Any) → str[source]¶
Asynchronously version of run.
classmethod construct(_fields_set: Optional[SetStr] = None, **values: Any) → Model¶
... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.searx_search.SearxSearchWrapper.html |
6ddac03f1f4a-2 | Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.
classmethod from_orm(obj: Any) → Model¶
json(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, by_alias: bool = False,... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.searx_search.SearxSearchWrapper.html |
6ddac03f1f4a-3 | categories – List of categories to use for the query.
**kwargs – extra parameters to pass to the searx API.
Returns
{snippet: The description of the result.
title: The title of the result.
link: The link to the result.
engines: The engines used for the result.
category: Searx category of the result.
}
Return type
Dic... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.searx_search.SearxSearchWrapper.html |
6ddac03f1f4a-4 | classmethod schema_json(*, by_alias: bool = True, ref_template: unicode = '#/definitions/{model}', **dumps_kwargs: Any) → unicode¶
classmethod update_forward_refs(**localns: Any) → None¶
Try to update ForwardRefs on fields based on this Model, globalns and localns.
classmethod validate(value: Any) → Model¶
Examples usi... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.searx_search.SearxSearchWrapper.html |
e0d8a7433728-0 | langchain.utilities.powerbi.fix_table_name¶
langchain.utilities.powerbi.fix_table_name(table: str) → str[source]¶
Add single quotes around table names that contain spaces. | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.powerbi.fix_table_name.html |
50938d4643cc-0 | langchain.utilities.clickup.fetch_list_id¶
langchain.utilities.clickup.fetch_list_id(space_id: int, folder_id: int, access_token: str) → Optional[int][source]¶
Fetch the list id. | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.clickup.fetch_list_id.html |
c96e96c956f0-0 | langchain.utilities.bing_search.BingSearchAPIWrapper¶
class langchain.utilities.bing_search.BingSearchAPIWrapper[source]¶
Bases: BaseModel
Wrapper for Bing Search API.
In order to set this up, follow instructions at:
https://levelup.gitconnected.com/api-tutorial-how-to-use-bing-web-search-api-in-python-4165d5592a7e
Cre... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.bing_search.BingSearchAPIWrapper.html |
c96e96c956f0-1 | deep – set to True to make a deep copy of the model
Returns
new model instance
dict(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, by_alias: bool = False, skip_defaults: Optional[bool] = None, exclude_unset: bool = False, ex... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.bing_search.BingSearchAPIWrapper.html |
c96e96c956f0-2 | results(query: str, num_results: int) → List[Dict][source]¶
Run query through BingSearch and return metadata.
Parameters
query – The query to search for.
num_results – The number of results to return.
Returns
snippet - The description of the result.
title - The title of the result.
link - The link to the result.
Return... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.bing_search.BingSearchAPIWrapper.html |
a5ccc169a123-0 | langchain.utilities.duckduckgo_search.DuckDuckGoSearchAPIWrapper¶
class langchain.utilities.duckduckgo_search.DuckDuckGoSearchAPIWrapper[source]¶
Bases: BaseModel
Wrapper for DuckDuckGo Search API.
Free and does not require any setup.
Create a new model by parsing and validating input data from keyword arguments.
Raise... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.duckduckgo_search.DuckDuckGoSearchAPIWrapper.html |
a5ccc169a123-1 | deep – set to True to make a deep copy of the model
Returns
new model instance
dict(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, by_alias: bool = False, skip_defaults: Optional[bool] = None, exclude_unset: bool = False, ex... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.duckduckgo_search.DuckDuckGoSearchAPIWrapper.html |
a5ccc169a123-2 | classmethod parse_obj(obj: Any) → Model¶
classmethod parse_raw(b: Union[str, bytes], *, content_type: unicode = None, encoding: unicode = 'utf8', proto: Protocol = None, allow_pickle: bool = False) → Model¶
results(query: str, num_results: int, backend: str = 'api') → List[Dict[str, str]][source]¶
Run query through Duc... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.duckduckgo_search.DuckDuckGoSearchAPIWrapper.html |
87af5191b174-0 | langchain.utilities.clickup.CUList¶
class langchain.utilities.clickup.CUList(folder_id: float, name: str, content: Optional[str] = None, due_date: Optional[int] = None, due_date_time: Optional[bool] = None, priority: Optional[int] = None, assignee: Optional[int] = None, status: Optional[str] = None)[source]¶
Component ... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.clickup.CUList.html |
2faf1199b577-0 | langchain.utilities.bibtex.BibtexparserWrapper¶
class langchain.utilities.bibtex.BibtexparserWrapper[source]¶
Bases: BaseModel
Wrapper around bibtexparser.
To use, you should have the bibtexparser python package installed.
https://bibtexparser.readthedocs.io/en/master/
This wrapper will use bibtexparser to load a colle... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.bibtex.BibtexparserWrapper.html |
2faf1199b577-1 | deep – set to True to make a deep copy of the model
Returns
new model instance
dict(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, by_alias: bool = False, skip_defaults: Optional[bool] = None, exclude_unset: bool = False, ex... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.bibtex.BibtexparserWrapper.html |
2faf1199b577-2 | classmethod parse_obj(obj: Any) → Model¶
classmethod parse_raw(b: Union[str, bytes], *, content_type: unicode = None, encoding: unicode = 'utf8', proto: Protocol = None, allow_pickle: bool = False) → Model¶
classmethod schema(by_alias: bool = True, ref_template: unicode = '#/definitions/{model}') → DictStrAny¶
classmet... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.bibtex.BibtexparserWrapper.html |
d2b828562d91-0 | langchain.utilities.max_compute.MaxComputeAPIWrapper¶
class langchain.utilities.max_compute.MaxComputeAPIWrapper(client: ODPS)[source]¶
Interface for querying Alibaba Cloud MaxCompute tables.
Initialize MaxCompute document loader.
Parameters
client – odps.ODPS MaxCompute client object.
Methods
__init__(client)
Initiali... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.max_compute.MaxComputeAPIWrapper.html |
b6f3bb8f5cec-0 | langchain.utilities.openweathermap.OpenWeatherMapAPIWrapper¶
class langchain.utilities.openweathermap.OpenWeatherMapAPIWrapper[source]¶
Bases: BaseModel
Wrapper for OpenWeatherMap API using PyOWM.
Docs for using:
Go to OpenWeatherMap and sign up for an API key
Save your API KEY into OPENWEATHERMAP_API_KEY env variable
... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.openweathermap.OpenWeatherMapAPIWrapper.html |
b6f3bb8f5cec-1 | deep – set to True to make a deep copy of the model
Returns
new model instance
dict(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, by_alias: bool = False, skip_defaults: Optional[bool] = None, exclude_unset: bool = False, ex... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.openweathermap.OpenWeatherMapAPIWrapper.html |
b6f3bb8f5cec-2 | run(location: str) → str[source]¶
Get the current weather information for a specified location.
classmethod schema(by_alias: bool = True, ref_template: unicode = '#/definitions/{model}') → DictStrAny¶
classmethod schema_json(*, by_alias: bool = True, ref_template: unicode = '#/definitions/{model}', **dumps_kwargs: Any)... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.openweathermap.OpenWeatherMapAPIWrapper.html |
ac6f64fe2eb6-0 | langchain.utilities.searchapi.SearchApiAPIWrapper¶
class langchain.utilities.searchapi.SearchApiAPIWrapper[source]¶
Bases: BaseModel
Wrapper around SearchApi API.
To use, you should have the environment variable SEARCHAPI_API_KEY
set with your API key, or pass searchapi_api_key
as a named parameter to the constructor.
... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.searchapi.SearchApiAPIWrapper.html |
ac6f64fe2eb6-1 | exclude – fields to exclude from new model, as with values this takes precedence over include
update – values to change/add in the new model. Note: the data is not validated before creating
the new model: you should trust this data
deep – set to True to make a deep copy of the model
Returns
new model instance
dict(*, i... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.searchapi.SearchApiAPIWrapper.html |
ac6f64fe2eb6-2 | classmethod parse_obj(obj: Any) → Model¶
classmethod parse_raw(b: Union[str, bytes], *, content_type: unicode = None, encoding: unicode = 'utf8', proto: Protocol = None, allow_pickle: bool = False) → Model¶
results(query: str, **kwargs: Any) → dict[source]¶
run(query: str, **kwargs: Any) → str[source]¶
classmethod sche... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.searchapi.SearchApiAPIWrapper.html |
d8b8fdd14a31-0 | langchain.utilities.tavily_search.TavilySearchAPIWrapper¶
class langchain.utilities.tavily_search.TavilySearchAPIWrapper[source]¶
Bases: BaseModel
Wrapper for Tavily Search API.
Create a new model by parsing and validating input data from keyword arguments.
Raises ValidationError if the input data cannot be parsed to f... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.tavily_search.TavilySearchAPIWrapper.html |
d8b8fdd14a31-1 | deep – set to True to make a deep copy of the model
Returns
new model instance
dict(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, by_alias: bool = False, skip_defaults: Optional[bool] = None, exclude_unset: bool = False, ex... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.tavily_search.TavilySearchAPIWrapper.html |
d8b8fdd14a31-2 | raw_results(query: str, max_results: Optional[int] = 5, search_depth: Optional[str] = 'advanced', include_domains: Optional[List[str]] = [], exclude_domains: Optional[List[str]] = [], include_answer: Optional[bool] = False, include_raw_content: Optional[bool] = False, include_images: Optional[bool] = False) → Dict[sour... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.tavily_search.TavilySearchAPIWrapper.html |
d8b8fdd14a31-3 | Returns
The query that was searched for.
follow_up_questions: A list of follow up questions.
response_time: The response time of the query.
answer: The answer to the query.
images: A list of images.
results: A list of dictionaries containing the results:
title: The title of the result.
url: The url of the result.
conte... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.tavily_search.TavilySearchAPIWrapper.html |
77b5e4f1e2b5-0 | langchain.utilities.clickup.Task¶
class langchain.utilities.clickup.Task(id: int, name: str, text_content: str, description: str, status: str, creator_id: int, creator_username: str, creator_email: str, assignees: List[Dict[str, Any]], watchers: List[Dict[str, Any]], priority: Optional[str], due_date: Optional[str], st... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.clickup.Task.html |
8e7fe87d3e5a-0 | langchain.utilities.dalle_image_generator.DallEAPIWrapper¶
class langchain.utilities.dalle_image_generator.DallEAPIWrapper[source]¶
Bases: BaseModel
Wrapper for OpenAI’s DALL-E Image Generator.
https://platform.openai.com/docs/guides/images/generations?context=node
Usage instructions:
pip install openai
save your OPENA... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.dalle_image_generator.DallEAPIWrapper.html |
8e7fe87d3e5a-1 | exclude – fields to exclude from new model, as with values this takes precedence over include
update – values to change/add in the new model. Note: the data is not validated before creating
the new model: you should trust this data
deep – set to True to make a deep copy of the model
Returns
new model instance
dict(*, i... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.dalle_image_generator.DallEAPIWrapper.html |
8e7fe87d3e5a-2 | classmethod parse_obj(obj: Any) → Model¶
classmethod parse_raw(b: Union[str, bytes], *, content_type: unicode = None, encoding: unicode = 'utf8', proto: Protocol = None, allow_pickle: bool = False) → Model¶
run(query: str) → str[source]¶
Run query through OpenAI and parse result.
classmethod schema(by_alias: bool = Tru... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.dalle_image_generator.DallEAPIWrapper.html |
03d1297aec3f-0 | langchain.utilities.google_search.GoogleSearchAPIWrapper¶
class langchain.utilities.google_search.GoogleSearchAPIWrapper[source]¶
Bases: BaseModel
Wrapper for Google Search API.
Adapted from: Instructions adapted from https://stackoverflow.com/questions/
37083058/
programmatically-searching-google-in-python-using-custo... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.google_search.GoogleSearchAPIWrapper.html |
03d1297aec3f-1 | Raises ValidationError if the input data cannot be parsed to form a valid model.
param google_api_key: Optional[str] = None¶
param google_cse_id: Optional[str] = None¶
param k: int = 10¶
param siterestrict: bool = False¶
classmethod construct(_fields_set: Optional[SetStr] = None, **values: Any) → Model¶
Creates a new m... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.google_search.GoogleSearchAPIWrapper.html |
03d1297aec3f-2 | Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.
classmethod from_orm(obj: Any) → Model¶
json(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, by_alias: bool = False,... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.google_search.GoogleSearchAPIWrapper.html |
03d1297aec3f-3 | Return type
A list of dictionaries with the following keys
run(query: str) → str[source]¶
Run query through GoogleSearch and parse result.
classmethod schema(by_alias: bool = True, ref_template: unicode = '#/definitions/{model}') → DictStrAny¶
classmethod schema_json(*, by_alias: bool = True, ref_template: unicode = '#... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.google_search.GoogleSearchAPIWrapper.html |
2a7227c78253-0 | langchain.utilities.sql_database.truncate_word¶
langchain.utilities.sql_database.truncate_word(content: Any, *, length: int, suffix: str = '...') → str[source]¶
Truncate a string to a certain number of words, based on the max string
length. | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.sql_database.truncate_word.html |
0c48a14862c9-0 | langchain.utilities.clickup.Team¶
class langchain.utilities.clickup.Team(id: int, name: str, members: List[Member])[source]¶
Component class for a team.
Attributes
id
name
members
Methods
__init__(id, name, members)
from_data(data)
__init__(id: int, name: str, members: List[Member]) → None¶
classmethod from_data(data: ... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.clickup.Team.html |
7c01ae16e273-0 | langchain.utilities.clickup.fetch_folder_id¶
langchain.utilities.clickup.fetch_folder_id(space_id: int, access_token: str) → Optional[int][source]¶
Fetch the folder id. | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.clickup.fetch_folder_id.html |
2b1cf88a1def-0 | langchain.utilities.clickup.Component¶
class langchain.utilities.clickup.Component[source]¶
Base class for all components.
Methods
__init__()
from_data(data)
__init__() → None¶
classmethod from_data(data: Dict[str, Any]) → Component[source]¶ | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.clickup.Component.html |
0ccbea45c065-0 | langchain.utilities.opaqueprompts.desanitize¶
langchain.utilities.opaqueprompts.desanitize(sanitized_text: str, secure_context: bytes) → str[source]¶
Restore the original sensitive data from the sanitized text.
Parameters
sanitized_text – Sanitized text.
secure_context – Secure context returned by the sanitize function... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.opaqueprompts.desanitize.html |
b0431ae01cf1-0 | langchain.utilities.redis.check_redis_module_exist¶
langchain.utilities.redis.check_redis_module_exist(client: RedisType, required_modules: List[dict]) → None[source]¶
Check if the correct Redis modules are installed. | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.redis.check_redis_module_exist.html |
8f085c1c5a8b-0 | langchain.utilities.clickup.fetch_first_id¶
langchain.utilities.clickup.fetch_first_id(data: dict, key: str) → Optional[int][source]¶
Fetch the first id from a dictionary. | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.clickup.fetch_first_id.html |
3aee540d7437-0 | langchain.utilities.openapi.OpenAPISpec¶
class langchain.utilities.openapi.OpenAPISpec[source]¶
OpenAPI Model that removes mis-formatted parts of the spec.
Attributes
base_url
Get the base url.
openapi
Methods
__init__()
from_file(path)
Get an OpenAPI spec from a file path.
from_spec_dict(spec_dict)
Get an OpenAPI spec... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.openapi.OpenAPISpec.html |
3aee540d7437-1 | Get a cleaned operation id from an operation id.
get_methods_for_path(path: str) → List[str][source]¶
Return a list of valid methods for the specified path.
get_operation(path: str, method: str) → Operation[source]¶
Get the operation object for a given path and HTTP method.
get_parameters_for_operation(operation: Opera... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.openapi.OpenAPISpec.html |
bc653ec49efe-0 | langchain.utilities.alpha_vantage.AlphaVantageAPIWrapper¶
class langchain.utilities.alpha_vantage.AlphaVantageAPIWrapper[source]¶
Bases: BaseModel
Wrapper for AlphaVantage API for Currency Exchange Rate.
Docs for using:
Go to AlphaVantage and sign up for an API key
Save your API KEY into ALPHAVANTAGE_API_KEY env variab... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.alpha_vantage.AlphaVantageAPIWrapper.html |
bc653ec49efe-1 | deep – set to True to make a deep copy of the model
Returns
new model instance
dict(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, by_alias: bool = False, skip_defaults: Optional[bool] = None, exclude_unset: bool = False, ex... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.alpha_vantage.AlphaVantageAPIWrapper.html |
bc653ec49efe-2 | run(from_currency: str, to_currency: str) → str[source]¶
Get the current exchange rate for a specified currency pair.
classmethod schema(by_alias: bool = True, ref_template: unicode = '#/definitions/{model}') → DictStrAny¶
classmethod schema_json(*, by_alias: bool = True, ref_template: unicode = '#/definitions/{model}'... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.alpha_vantage.AlphaVantageAPIWrapper.html |
d2f9ba547695-0 | langchain.utilities.brave_search.BraveSearchWrapper¶
class langchain.utilities.brave_search.BraveSearchWrapper[source]¶
Bases: BaseModel
Wrapper around the Brave search engine.
Create a new model by parsing and validating input data from keyword arguments.
Raises ValidationError if the input data cannot be parsed to fo... | lang/api.python.langchain.com/en/latest/utilities/langchain.utilities.brave_search.BraveSearchWrapper.html |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.