AxAPIConfig
Defined in: https://github.com/ax-llm/ax/blob/7965c876f6a5b641e0cf166e8942e540cfde65e1/src/ax/util/apicall.ts#L61
Extends
AxAPI.RequestValidation.ResponseValidation
Properties
| Property | Type | Description | Overrides | Inherited from |
|---|---|---|---|---|
abortSignal? | AbortSignal | - | - | - |
corsProxy? | string | - | - | - |
debug? | boolean | - | - | - |
fetch? | { (input: URL | RequestInfo, init?: RequestInit): Promise<Response>; (input: string | URL | Request, init?: RequestInit): Promise<Response>; } | - | - | - |
headers? | Record<string, string> | - | - | AxAPI.headers |
includeRequestBodyInErrors? | boolean | Whether to include request body in error messages. Defaults to true. Set to false when request may contain sensitive data or large base64 content. | - | - |
localCall? | <TRequest, TResponse>(data: TRequest, stream?: boolean) => Promise<TResponse | ReadableStream<TResponse>> | - | - | AxAPI.localCall |
method? | "POST" | "PUT" | "PATCH" | HTTP method for JSON API requests. Defaults to POST. | - | AxAPI.method |
name? | string | - | - | AxAPI.name |
onResponseMetadata? | (metadata: Readonly<AxAPIResponseMetadata>) => void | - | - | - |
put? | boolean | Deprecated Use method: 'PUT' instead. | - | AxAPI.put |
retry? | Partial<RetryConfig> | - | - | - |
span? | Span | - | - | - |
stream? | boolean | - | - | - |
timeout? | number | - | - | - |
url? | string | URL | - | AxAPI.url | - |
validateRequest? | (request: unknown) => boolean | Promise<boolean> | - | - | RequestValidation.validateRequest |
validateResponse? | (response: unknown) => boolean | Promise<boolean> | - | - | ResponseValidation.validateResponse |
verbose? | boolean | - | - | - |