langchain_community.tools.openapi.utils.api_models.APIOperation

class langchain_community.tools.openapi.utils.api_models.APIOperation[source]

Bases: BaseModel

一个单一API操作的模型。

通过解析和验证关键字参数中的输入数据来创建一个新的模型。

如果输入数据不能被解析成有效的模型，则引发ValidationError。

参数 base_url: str [必须]

操作的基URL。

参数 description: 可选[str] = None

操作的描述。

参数 method: HTTPVerb [必须]

操作的HTTP方法。

参数 operation_id: str [必须]

操作的唯一标识符。

参数 path: str [必须]

操作的路径。

参数 properties: 序列[APIProperty] [必须]
参数 request_body: 可选[APIRequestBody] = None

操作请求的内容。

classmethod 从_openapi_spec(spec: OpenAPISpec, path: str, method: str) → APIOperation[来源]

从 OpenAPI 规范创建一个 APIOperation 对象。

参数

  • spec (OpenAPISpec) –

  • path (str) –

  • method (str) –

返回类型

APIOperation

classmethod 从_openapi_url(spec_url: str, path: str, method: str) → APIOperation[来源]

从 OpenAPI URL 创建一个 APIOperation 对象。

参数

  • spec_url (str) –

  • path (str) –

  • method (str) –

返回类型

APIOperation

to_typescript() → str[来源]

获取操作的 TypeScript 字符串表示形式。

返回类型

str

static ts_type_from_python(type_: Union[str, Type, tuple, None, Enum]) → str[来源]
参数

type_ （Union[str, Type, tuple, None, Enum]） –

返回类型

str

属性 body_params: List[str]
属性 path_params: List[str]
属性 query_params: List[str]