API操作#

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

基础类：BaseModel

单个API操作的模型。

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

如果输入数据无法验证以形成有效模型，则引发 [ValidationError][pydantic_core.ValidationError]。

self 被显式地设为仅位置参数，以允许 self 作为字段名称。

param base_url: str [Required]#

操作的基本URL。

param description: str | None [Required]#

操作的描述。

param method: HTTPVerb [Required]#

操作的HTTP方法。

param operation_id: str [Required]#

操作的唯一标识符。

param path: str [Required]#

操作的路径。

param properties: Sequence[APIProperty] [Required]#
param request_body: APIRequestBody | None [Required]#

操作的请求体。

classmethod from_openapi_spec(spec: OpenAPISpec, path: str, method: str) → APIOperation[source]#

从OpenAPI规范创建一个APIOperation。

Parameters:
Return type:

APIOperation

classmethod from_openapi_url(spec_url: str, path: str, method: str) → APIOperation[来源]#

从OpenAPI URL创建一个APIOperation。

Parameters:

  • spec_url (str)

  • path (str)

  • 方法 (字符串)

Return type:

APIOperation

to_typescript() → str[源代码]#

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

Return type:

字符串

static ts_type_from_python(type_: str | Type | tuple | None | Enum) → str[source]#
Parameters:

type_ (str | Type | tuple | None | Enum)

Return type:

字符串

property body_params: List[str]#
property path_params: List[str]#
property query_params: List[str]#