OpenAPI规范#

class langchain_community.utilities.openapi.OpenAPISpec[源代码]#

OpenAPI 模型,用于移除规范中格式错误的部分。

属性

base_url

获取基础URL。

openapi

方法

from_file(path)

从文件路径获取OpenAPI规范。

from_spec_dict(spec_dict)

从字典中获取OpenAPI规范。

from_text(text)

从文本中获取OpenAPI规范。

from_url(url)

从URL获取OpenAPI规范。

get_cleaned_operation_id(operation, path, method)

从操作ID中获取一个清理后的操作ID。

get_methods_for_path(path)

返回指定路径的有效方法列表。

get_operation(path, method)

获取给定路径和HTTP方法的操作对象。

get_parameters_for_operation(operation)

获取给定操作的组件。

get_parameters_for_path(path)

get_referenced_schema(ref)

获取一个模式(或嵌套引用)或错误。

get_request_body_for_operation(operation)

获取给定操作的请求体。

get_schema(schema[, depth, max_depth])

parse_obj(obj)

classmethod from_file(path: str | Path) OpenAPISpec[source]#

从文件路径获取OpenAPI规范。

Parameters:

路径 (字符串 | 路径)

Return type:

OpenAPISpec

classmethod from_spec_dict(spec_dict: dict) OpenAPISpec[source]#

从字典中获取OpenAPI规范。

Parameters:

spec_dict (dict)

Return type:

OpenAPISpec

classmethod from_text(text: str) OpenAPISpec[来源]#

从文本中获取OpenAPI规范。

Parameters:

文本 (str)

Return type:

OpenAPISpec

classmethod from_url(url: str) OpenAPISpec[source]#

从URL获取OpenAPI规范。

Parameters:

url (str)

Return type:

OpenAPISpec

static get_cleaned_operation_id(operation: Operation, path: str, method: str) str[source]#

从操作ID中获取一个清理后的操作ID。

Parameters:
  • 操作 (Operation)

  • path (str)

  • 方法 (字符串)

Return type:

字符串

get_methods_for_path(path: str) List[str][来源]#

返回指定路径的有效方法列表。

Parameters:

路径 (字符串)

Return type:

列表[str]

get_operation(path: str, method: str) Operation[source]#

获取给定路径和HTTP方法的操作对象。

Parameters:
  • path (str)

  • 方法 (字符串)

Return type:

Operation

get_parameters_for_operation(operation: Operation) List[Parameter][来源]#

获取给定操作的组件。

Parameters:

操作 (Operation)

Return type:

列表[Parameter]

get_parameters_for_path(path: str) List[Parameter][source]#
Parameters:

路径 (字符串)

Return type:

列表[Parameter]

get_referenced_schema(ref: Reference) Schema[源代码]#

获取一个模式(或嵌套引用)或错误。

Parameters:

ref (参考)

Return type:

Schema

get_request_body_for_operation(operation: Operation) RequestBody | None[source]#

获取给定操作的请求体。

Parameters:

操作 (Operation)

Return type:

可选的[RequestBody]

get_schema(schema: Reference | Schema, depth: int = 0, max_depth: int | None = None) Schema[source]#
Parameters:
  • schema (联合[参考, Schema])

  • 深度 (整数)

  • max_depth (可选[int])

Return type:

Schema

classmethod parse_obj(obj: dict) OpenAPISpec[source]#
Parameters:

obj (字典)

Return type:

OpenAPISpec