id stringlengths 14 15 | text stringlengths 44 2.47k | source stringlengths 61 181 |
|---|---|---|
96ac09b8f13d-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 ... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.apify.ApifyWrapper.html |
96ac09b8f13d-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,... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.apify.ApifyWrapper.html |
96ac09b8f13d-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 ... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.apify.ApifyWrapper.html |
96ac09b8f13d-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... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.apify.ApifyWrapper.html |
d13af3742dc5-0 | langchain.utilities.portkey.Portkey¶
class langchain.utilities.portkey.Portkey[source]¶
Portkey configuration.
base¶
The base URL for the Portkey API.
Default: “https://api.portkey.ai/v1/proxy”
Attributes
base
Methods
Config(api_key[, trace_id, environment, ...])
__init__()
static Config(api_key: str, trace_id: Optiona... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.portkey.Portkey.html |
0492f0759ba8-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... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.brave_search.BraveSearchWrapper.html |
0492f0759ba8-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... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.brave_search.BraveSearchWrapper.html |
0492f0759ba8-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]¶
Query the Brave search engine and return the results as a JSON string.
Parameters
... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.brave_search.BraveSearchWrapper.html |
50c697c3227c-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... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.github.GitHubAPIWrapper.html |
50c697c3227c-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... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.github.GitHubAPIWrapper.html |
50c697c3227c-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_... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.github.GitHubAPIWrapper.html |
50c697c3227c-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_... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.github.GitHubAPIWrapper.html |
211e2e03cdc5-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... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.requests.Requests.html |
211e2e03cdc5-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... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.requests.Requests.html |
211e2e03cdc5-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... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.requests.Requests.html |
211e2e03cdc5-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... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.requests.Requests.html |
98f74b834ac7-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... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.zapier.ZapierNLAWrapper.html |
98f74b834ac7-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... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.zapier.ZapierNLAWrapper.html |
98f74b834ac7-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... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.zapier.ZapierNLAWrapper.html |
98f74b834ac7-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... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.zapier.ZapierNLAWrapper.html |
98f74b834ac7-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... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.zapier.ZapierNLAWrapper.html |
98f74b834ac7-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 | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.zapier.ZapierNLAWrapper.html |
1545785f5dad-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... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.vertexai.init_vertexai.html |
29fd4ca1319e-0 | langchain.utilities.golden_query.GoldenQueryAPIWrapper¶
class langchain.utilities.golden_query.GoldenQueryAPIWrapper[source]¶
Bases: BaseModel
Wrapper for Golden.
Docs for using:
Go to https://golden.com and sign up for an account
Get your API Key from https://golden.com/settings/api
Save your API Key into GOLDEN_API_K... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.golden_query.GoldenQueryAPIWrapper.html |
29fd4ca1319e-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... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.golden_query.GoldenQueryAPIWrapper.html |
29fd4ca1319e-2 | run(query: str) → str[source]¶
Run query through Golden Query API and return the JSON raw result.
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: An... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.golden_query.GoldenQueryAPIWrapper.html |
8372b5ec905e-0 | langchain.utilities.scenexplain.SceneXplainAPIWrapper¶
class langchain.utilities.scenexplain.SceneXplainAPIWrapper[source]¶
Bases: BaseSettings, BaseModel
Wrapper for SceneXplain API.
In order to set this up, you need API key for the SceneXplain API.
You can obtain a key by following the steps below.
- Sign up for a fr... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.scenexplain.SceneXplainAPIWrapper.html |
8372b5ec905e-1 | 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(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, by_alias: bool = False, skip_defaults: Optional[boo... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.scenexplain.SceneXplainAPIWrapper.html |
8372b5ec905e-2 | run(image: str) → str[source]¶
Run SceneXplain image explainer.
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_f... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.scenexplain.SceneXplainAPIWrapper.html |
637408bd961e-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... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.max_compute.MaxComputeAPIWrapper.html |
7eac79155caf-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... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.gitlab.GitLabAPIWrapper.html |
7eac79155caf-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... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.gitlab.GitLabAPIWrapper.html |
7eac79155caf-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... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.gitlab.GitLabAPIWrapper.html |
7eac79155caf-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... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.gitlab.GitLabAPIWrapper.html |
7eac79155caf-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 | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.gitlab.GitLabAPIWrapper.html |
b70aafc98ecc-0 | langchain.utilities.powerbi.json_to_md¶
langchain.utilities.powerbi.json_to_md(json_contents: List[Dict[str, Union[str, int, float]]], table_name: Optional[str] = None) → str[source]¶
Converts a JSON object to a markdown table. | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.powerbi.json_to_md.html |
3f115690ca7a-0 | langchain.utilities.requests.RequestsWrapper¶
langchain.utilities.requests.RequestsWrapper¶
alias of TextRequestsWrapper
Examples using RequestsWrapper¶
OpenAPI | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.requests.RequestsWrapper.html |
a1eb8aee6138-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.
... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.searchapi.SearchApiAPIWrapper.html |
a1eb8aee6138-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... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.searchapi.SearchApiAPIWrapper.html |
a1eb8aee6138-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... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.searchapi.SearchApiAPIWrapper.html |
07d1e791762f-0 | langchain.utilities.jira.JiraAPIWrapper¶
class langchain.utilities.jira.JiraAPIWrapper[source]¶
Bases: BaseModel
Wrapper for Jira 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 confluence: Any = ... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.jira.JiraAPIWrapper.html |
07d1e791762f-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... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.jira.JiraAPIWrapper.html |
07d1e791762f-2 | classmethod parse_obj(obj: Any) → Model¶
parse_projects(projects: List[dict]) → List[dict][source]¶
classmethod parse_raw(b: Union[str, bytes], *, content_type: unicode = None, encoding: unicode = 'utf8', proto: Protocol = None, allow_pickle: bool = False) → Model¶
project() → str[source]¶
run(mode: str, query: str) → ... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.jira.JiraAPIWrapper.html |
8c46520f55ee-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.
Methods
__init__()
from_file(path)
Get an OpenAPI spec from a file path.
from_spec_dict(spec_dict)
Get an OpenAPI spec from a ... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.openapi.OpenAPISpec.html |
8c46520f55ee-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... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.openapi.OpenAPISpec.html |
5c6cfc0c5f88-0 | langchain.utilities.serpapi.SerpAPIWrapper¶
class langchain.utilities.serpapi.SerpAPIWrapper[source]¶
Bases: BaseModel
Wrapper around SerpAPI.
To use, you should have the google-search-results python package installed,
and the environment variable SERPAPI_API_KEY set with your API key, or pass
serpapi_api_key as a name... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.serpapi.SerpAPIWrapper.html |
5c6cfc0c5f88-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... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.serpapi.SerpAPIWrapper.html |
5c6cfc0c5f88-2 | Get parameters for SerpAPI.
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: bool = ... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.serpapi.SerpAPIWrapper.html |
5c6cfc0c5f88-3 | Try to update ForwardRefs on fields based on this Model, globalns and localns.
classmethod validate(value: Any) → Model¶
Examples using SerpAPIWrapper¶
SerpAPI
Bittensor
AutoGPT | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.serpapi.SerpAPIWrapper.html |
fdc995852593-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... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.searx_search.SearxSearchWrapper.html |
fdc995852593-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¶
... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.searx_search.SearxSearchWrapper.html |
fdc995852593-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,... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.searx_search.SearxSearchWrapper.html |
fdc995852593-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... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.searx_search.SearxSearchWrapper.html |
fdc995852593-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... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.searx_search.SearxSearchWrapper.html |
1aefee588ee3-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... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.duckduckgo_search.DuckDuckGoSearchAPIWrapper.html |
1aefee588ee3-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... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.duckduckgo_search.DuckDuckGoSearchAPIWrapper.html |
1aefee588ee3-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... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.duckduckgo_search.DuckDuckGoSearchAPIWrapper.html |
3ce998e8f17c-0 | langchain.utilities.powerbi.PowerBIDataset¶
class langchain.utilities.powerbi.PowerBIDataset[source]¶
Bases: BaseModel
Create PowerBI engine from dataset ID and credential or token.
Use either the credential or a supplied token to authenticate.
If both are supplied the credential is used to generate a token.
The impers... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.powerbi.PowerBIDataset.html |
3ce998e8f17c-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... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.powerbi.PowerBIDataset.html |
3ce998e8f17c-2 | get_table_names() → Iterable[str][source]¶
Get names of tables available.
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... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.powerbi.PowerBIDataset.html |
3ce998e8f17c-3 | classmethod validate(value: Any) → Model¶
property headers: Dict[str, str]¶
Get the token.
property request_url: str¶
Get the request url.
property table_info: str¶
Information about all tables in the database.
Examples using PowerBIDataset¶
PowerBI Dataset | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.powerbi.PowerBIDataset.html |
011940712f6a-0 | langchain.utilities.python.PythonREPL¶
class langchain.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 valid model.
param globals:... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.python.PythonREPL.html |
011940712f6a-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... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.python.PythonREPL.html |
011940712f6a-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... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.python.PythonREPL.html |
81115b7f006c-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... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.pubmed.PubMedAPIWrapper.html |
81115b7f006c-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... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.pubmed.PubMedAPIWrapper.html |
81115b7f006c-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... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.pubmed.PubMedAPIWrapper.html |
81115b7f006c-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... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.pubmed.PubMedAPIWrapper.html |
a1594a77c99b-0 | langchain.utilities.vertexai.raise_vertex_import_error¶
langchain.utilities.vertexai.raise_vertex_import_error(minimum_expected_version: str = '1.33.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... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.vertexai.raise_vertex_import_error.html |
62621c51282d-0 | langchain.utilities.metaphor_search.MetaphorSearchAPIWrapper¶
class langchain.utilities.metaphor_search.MetaphorSearchAPIWrapper[source]¶
Bases: BaseModel
Wrapper for Metaphor Search API.
Create a new model by parsing and validating input data from keyword arguments.
Raises ValidationError if the input data cannot be p... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.metaphor_search.MetaphorSearchAPIWrapper.html |
62621c51282d-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... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.metaphor_search.MetaphorSearchAPIWrapper.html |
62621c51282d-2 | results(query: str, num_results: int, include_domains: Optional[List[str]] = None, exclude_domains: Optional[List[str]] = None, start_crawl_date: Optional[str] = None, end_crawl_date: Optional[str] = None, start_published_date: Optional[str] = None, end_published_date: Optional[str] = None, use_autoprompt: Optional[boo... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.metaphor_search.MetaphorSearchAPIWrapper.html |
62621c51282d-3 | Return type
A list of dictionaries with the following keys
async results_async(query: str, num_results: int, include_domains: Optional[List[str]] = None, exclude_domains: Optional[List[str]] = None, start_crawl_date: Optional[str] = None, end_crawl_date: Optional[str] = None, start_published_date: Optional[str] = None,... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.metaphor_search.MetaphorSearchAPIWrapper.html |
44d94724cdea-0 | langchain.utilities.openapi.HTTPVerb¶
class langchain.utilities.openapi.HTTPVerb(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
Enumerator of the HTTP verbs.
GET = 'get'¶
PUT = 'put'¶
POST = 'post'¶
DELETE = 'delete'¶
OPTIONS = 'options'¶
HEAD = 'head'¶
PATCH = 'patch'¶
TR... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.openapi.HTTPVerb.html |
0547dbf37e02-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... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.redis.get_client.html |
fed8363d1915-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.
Docs for using:
1. pip install openai
2. save your OPENAI_API_KEY in an environment variable
Create a new model by parsing and... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.dalle_image_generator.DallEAPIWrapper.html |
fed8363d1915-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... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.dalle_image_generator.DallEAPIWrapper.html |
fed8363d1915-2 | run(query: str) → str[source]¶
Run query through OpenAI 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 = '#/definitions/{model}', **dumps_kwargs: Any) → unicode¶
classmetho... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.dalle_image_generator.DallEAPIWrapper.html |
3889d470a8bb-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... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.google_search.GoogleSearchAPIWrapper.html |
3889d470a8bb-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... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.google_search.GoogleSearchAPIWrapper.html |
3889d470a8bb-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,... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.google_search.GoogleSearchAPIWrapper.html |
3889d470a8bb-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 = '#... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.google_search.GoogleSearchAPIWrapper.html |
3bf0fcfea227-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. | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.redis.check_redis_module_exist.html |
315a21a9f7a9-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... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.opaqueprompts.desanitize.html |
135403d93ad2-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
... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.openweathermap.OpenWeatherMapAPIWrapper.html |
135403d93ad2-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... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.openweathermap.OpenWeatherMapAPIWrapper.html |
135403d93ad2-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)... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.openweathermap.OpenWeatherMapAPIWrapper.html |
92d2961496fe-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... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.bing_search.BingSearchAPIWrapper.html |
92d2961496fe-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... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.bing_search.BingSearchAPIWrapper.html |
92d2961496fe-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... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.bing_search.BingSearchAPIWrapper.html |
8da0d1342717-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... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.alpha_vantage.AlphaVantageAPIWrapper.html |
8da0d1342717-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... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.alpha_vantage.AlphaVantageAPIWrapper.html |
8da0d1342717-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}'... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.alpha_vantage.AlphaVantageAPIWrapper.html |
e7f9005dd840-0 | langchain.utilities.google_serper.GoogleSerperAPIWrapper¶
class langchain.utilities.google_serper.GoogleSerperAPIWrapper[source]¶
Bases: BaseModel
Wrapper around the Serper.dev Google Search API.
You can create a free API key at https://serper.dev.
To use, you should have the environment variable SERPER_API_KEY
set wit... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.google_serper.GoogleSerperAPIWrapper.html |
e7f9005dd840-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... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.google_serper.GoogleSerperAPIWrapper.html |
e7f9005dd840-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... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.google_serper.GoogleSerperAPIWrapper.html |
e7f9005dd840-3 | Try to update ForwardRefs on fields based on this Model, globalns and localns.
classmethod validate(value: Any) → Model¶
Examples using GoogleSerperAPIWrapper¶
Google Serper
Retrieve as you generate with FLARE | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.google_serper.GoogleSerperAPIWrapper.html |
631a7c1c7472-0 | langchain.utilities.google_places_api.GooglePlacesAPIWrapper¶
class langchain.utilities.google_places_api.GooglePlacesAPIWrapper[source]¶
Bases: BaseModel
Wrapper around Google Places API.
To use, you should have the googlemaps python package installed,an API key for the google maps platform,
and the environment variab... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.google_places_api.GooglePlacesAPIWrapper.html |
631a7c1c7472-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... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.google_places_api.GooglePlacesAPIWrapper.html |
631a7c1c7472-2 | classmethod parse_file(path: Union[str, Path], *, content_type: unicode = None, encoding: unicode = 'utf8', proto: Protocol = None, allow_pickle: bool = False) → Model¶
classmethod parse_obj(obj: Any) → Model¶
classmethod parse_raw(b: Union[str, bytes], *, content_type: unicode = None, encoding: unicode = 'utf8', proto... | https://api.python.langchain.com/en/latest/utilities/langchain.utilities.google_places_api.GooglePlacesAPIWrapper.html |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.