968 lines
36 KiB
Python
968 lines
36 KiB
Python
######################################################################
|
|
|
|
# /v1/batches Endpoints
|
|
|
|
|
|
######################################################################
|
|
import asyncio
|
|
from typing import Dict, Optional, cast
|
|
|
|
from fastapi import APIRouter, Depends, HTTPException, Path, Request, Response
|
|
|
|
import litellm
|
|
from litellm._logging import verbose_proxy_logger
|
|
from litellm.batches.main import CancelBatchRequest, RetrieveBatchRequest
|
|
from litellm.proxy._types import *
|
|
from litellm.proxy.auth.user_api_key_auth import user_api_key_auth
|
|
from litellm.proxy.common_request_processing import ProxyBaseLLMRequestProcessing
|
|
from litellm.proxy.common_utils.http_parsing_utils import _read_request_body
|
|
from litellm.proxy.common_utils.openai_endpoint_utils import (
|
|
get_custom_llm_provider_from_request_headers,
|
|
get_custom_llm_provider_from_request_query,
|
|
)
|
|
from litellm.proxy.openai_files_endpoints.common_utils import (
|
|
_is_base64_encoded_unified_file_id,
|
|
decode_model_from_file_id,
|
|
encode_batch_response_ids,
|
|
encode_file_id_with_model,
|
|
get_batch_from_database,
|
|
get_credentials_for_model,
|
|
get_model_id_from_unified_batch_id,
|
|
get_models_from_unified_file_id,
|
|
get_original_file_id,
|
|
prepare_data_with_credentials,
|
|
resolve_input_file_id_to_unified,
|
|
update_batch_in_database,
|
|
)
|
|
from litellm.proxy.utils import handle_exception_on_proxy, is_known_model
|
|
from litellm.types.llms.openai import LiteLLMBatchCreateRequest
|
|
|
|
router = APIRouter()
|
|
|
|
|
|
@router.post(
|
|
"/{provider}/v1/batches",
|
|
dependencies=[Depends(user_api_key_auth)],
|
|
tags=["batch"],
|
|
)
|
|
@router.post(
|
|
"/v1/batches",
|
|
dependencies=[Depends(user_api_key_auth)],
|
|
tags=["batch"],
|
|
)
|
|
@router.post(
|
|
"/batches",
|
|
dependencies=[Depends(user_api_key_auth)],
|
|
tags=["batch"],
|
|
)
|
|
async def create_batch( # noqa: PLR0915
|
|
request: Request,
|
|
fastapi_response: Response,
|
|
provider: Optional[str] = None,
|
|
user_api_key_dict: UserAPIKeyAuth = Depends(user_api_key_auth),
|
|
):
|
|
"""
|
|
Create large batches of API requests for asynchronous processing.
|
|
This is the equivalent of POST https://api.openai.com/v1/batch
|
|
Supports Identical Params as: https://platform.openai.com/docs/api-reference/batch
|
|
|
|
Example Curl
|
|
```
|
|
curl http://localhost:4000/v1/batches \
|
|
-H "Authorization: Bearer sk-1234" \
|
|
-H "Content-Type: application/json" \
|
|
-d '{
|
|
"input_file_id": "file-abc123",
|
|
"endpoint": "/v1/chat/completions",
|
|
"completion_window": "24h"
|
|
}'
|
|
```
|
|
"""
|
|
from litellm.proxy.proxy_server import (
|
|
general_settings,
|
|
llm_router,
|
|
proxy_config,
|
|
proxy_logging_obj,
|
|
version,
|
|
)
|
|
|
|
data: Dict = {}
|
|
try:
|
|
data = await _read_request_body(request=request)
|
|
verbose_proxy_logger.debug(
|
|
"Request received by LiteLLM:\n{}".format(json.dumps(data, indent=4)),
|
|
)
|
|
base_llm_response_processor = ProxyBaseLLMRequestProcessing(data=data)
|
|
(
|
|
data,
|
|
litellm_logging_obj,
|
|
) = await base_llm_response_processor.common_processing_pre_call_logic(
|
|
request=request,
|
|
general_settings=general_settings,
|
|
user_api_key_dict=user_api_key_dict,
|
|
version=version,
|
|
proxy_logging_obj=proxy_logging_obj,
|
|
proxy_config=proxy_config,
|
|
route_type="acreate_batch",
|
|
)
|
|
|
|
## check if model is a loadbalanced model
|
|
router_model: Optional[str] = None
|
|
is_router_model = False
|
|
if litellm.enable_loadbalancing_on_batch_endpoints is True:
|
|
router_model = data.get("model", None)
|
|
is_router_model = is_known_model(model=router_model, llm_router=llm_router)
|
|
|
|
custom_llm_provider = (
|
|
provider
|
|
or data.pop("custom_llm_provider", None)
|
|
or get_custom_llm_provider_from_request_headers(request=request)
|
|
or "openai"
|
|
)
|
|
_create_batch_data = LiteLLMBatchCreateRequest(**data)
|
|
|
|
# Apply team-level batch output expiry enforcement
|
|
team_metadata = user_api_key_dict.team_metadata or {}
|
|
enforced_batch_expiry = team_metadata.get("enforced_batch_output_expires_after")
|
|
if enforced_batch_expiry is not None:
|
|
if (
|
|
"anchor" not in enforced_batch_expiry
|
|
or "seconds" not in enforced_batch_expiry
|
|
):
|
|
raise HTTPException(
|
|
status_code=500,
|
|
detail={
|
|
"error": "Server configuration error: team metadata field 'enforced_batch_output_expires_after' is malformed - must contain 'anchor' and 'seconds' keys. Contact your team or proxy admin to fix this setting.",
|
|
},
|
|
)
|
|
if enforced_batch_expiry["anchor"] != "created_at":
|
|
raise HTTPException(
|
|
status_code=500,
|
|
detail={
|
|
"error": f"Server configuration error: team metadata field 'enforced_batch_output_expires_after' has invalid anchor '{enforced_batch_expiry['anchor']}' - must be 'created_at'. Contact your team or proxy admin to fix this setting.",
|
|
},
|
|
)
|
|
_create_batch_data["output_expires_after"] = {
|
|
"anchor": "created_at",
|
|
"seconds": int(enforced_batch_expiry["seconds"]),
|
|
}
|
|
|
|
input_file_id = _create_batch_data.get("input_file_id", None)
|
|
unified_file_id: Union[str, Literal[False]] = False
|
|
|
|
model_from_file_id = None
|
|
if input_file_id:
|
|
model_from_file_id = decode_model_from_file_id(input_file_id)
|
|
unified_file_id = _is_base64_encoded_unified_file_id(input_file_id)
|
|
|
|
# SCENARIO 1: File ID is encoded with model info
|
|
if model_from_file_id is not None and input_file_id:
|
|
credentials = get_credentials_for_model(
|
|
llm_router=llm_router,
|
|
model_id=model_from_file_id,
|
|
operation_context="batch creation (file created with model)",
|
|
)
|
|
|
|
original_file_id = get_original_file_id(input_file_id)
|
|
_create_batch_data["input_file_id"] = original_file_id
|
|
prepare_data_with_credentials(
|
|
data=_create_batch_data, # type: ignore
|
|
credentials=credentials,
|
|
)
|
|
|
|
# Create batch using model credentials
|
|
response = await litellm.acreate_batch(
|
|
custom_llm_provider=credentials["custom_llm_provider"],
|
|
**_create_batch_data, # type: ignore
|
|
)
|
|
|
|
# Encode the batch ID and related file IDs with model information
|
|
if response and hasattr(response, "id") and response.id:
|
|
original_batch_id = response.id
|
|
encoded_batch_id = encode_file_id_with_model(
|
|
file_id=original_batch_id,
|
|
model=model_from_file_id,
|
|
id_type="batch",
|
|
)
|
|
response.id = encoded_batch_id
|
|
|
|
if hasattr(response, "output_file_id") and response.output_file_id:
|
|
response.output_file_id = encode_file_id_with_model(
|
|
file_id=response.output_file_id, model=model_from_file_id
|
|
)
|
|
|
|
if hasattr(response, "error_file_id") and response.error_file_id:
|
|
response.error_file_id = encode_file_id_with_model(
|
|
file_id=response.error_file_id, model=model_from_file_id
|
|
)
|
|
|
|
verbose_proxy_logger.debug(
|
|
f"Created batch using model: {model_from_file_id}, "
|
|
f"original_batch_id: {original_batch_id}, encoded: {encoded_batch_id}"
|
|
)
|
|
|
|
response.input_file_id = input_file_id
|
|
|
|
elif (
|
|
litellm.enable_loadbalancing_on_batch_endpoints is True
|
|
and is_router_model
|
|
and router_model is not None
|
|
):
|
|
if llm_router is None:
|
|
raise HTTPException(
|
|
status_code=500,
|
|
detail={
|
|
"error": "LLM Router not initialized. Ensure models added to proxy."
|
|
},
|
|
)
|
|
|
|
response = await llm_router.acreate_batch(**_create_batch_data) # type: ignore
|
|
elif (
|
|
unified_file_id and input_file_id
|
|
): # litellm_proxy:application/octet-stream;unified_id,c4843482-b176-4901-8292-7523fd0f2c6e;target_model_names,gpt-4o-mini
|
|
target_model_names = get_models_from_unified_file_id(unified_file_id)
|
|
## EXPECTS 1 MODEL
|
|
if len(target_model_names) != 1:
|
|
raise HTTPException(
|
|
status_code=400,
|
|
detail={
|
|
"error": "Expected 1 model, got {}".format(
|
|
len(target_model_names)
|
|
)
|
|
},
|
|
)
|
|
model = target_model_names[0]
|
|
_create_batch_data["model"] = model
|
|
if llm_router is None:
|
|
raise HTTPException(
|
|
status_code=500,
|
|
detail={
|
|
"error": "LLM Router not initialized. Ensure models added to proxy."
|
|
},
|
|
)
|
|
|
|
response = await llm_router.acreate_batch(**_create_batch_data)
|
|
response.input_file_id = input_file_id
|
|
response._hidden_params["unified_file_id"] = unified_file_id
|
|
else:
|
|
# Check if model specified via header/query/body param
|
|
model_param = (
|
|
data.get("model")
|
|
or request.query_params.get("model")
|
|
or request.headers.get("x-litellm-model")
|
|
)
|
|
|
|
# SCENARIO 2 & 3: Model from header/query OR custom_llm_provider fallback
|
|
if model_param:
|
|
# SCENARIO 2: Use model-based routing from header/query/body
|
|
credentials = get_credentials_for_model(
|
|
llm_router=llm_router,
|
|
model_id=model_param,
|
|
operation_context="batch creation",
|
|
)
|
|
|
|
prepare_data_with_credentials(
|
|
data=_create_batch_data, # type: ignore
|
|
credentials=credentials,
|
|
)
|
|
|
|
# Create batch using model credentials
|
|
response = await litellm.acreate_batch(
|
|
custom_llm_provider=credentials["custom_llm_provider"],
|
|
**_create_batch_data, # type: ignore
|
|
)
|
|
|
|
encode_batch_response_ids(response, model=model_param)
|
|
|
|
verbose_proxy_logger.debug(f"Created batch using model: {model_param}")
|
|
else:
|
|
# SCENARIO 3: Fallback to custom_llm_provider (uses env variables)
|
|
response = await litellm.acreate_batch(
|
|
custom_llm_provider=custom_llm_provider, **_create_batch_data # type: ignore
|
|
)
|
|
|
|
### CALL HOOKS ### - modify outgoing data
|
|
response = await proxy_logging_obj.post_call_success_hook(
|
|
data=data, user_api_key_dict=user_api_key_dict, response=response
|
|
)
|
|
|
|
### ALERTING ###
|
|
asyncio.create_task(
|
|
proxy_logging_obj.update_request_status(
|
|
litellm_call_id=data.get("litellm_call_id", ""), status="success"
|
|
)
|
|
)
|
|
|
|
### RESPONSE HEADERS ###
|
|
hidden_params = getattr(response, "_hidden_params", {}) or {}
|
|
model_id = hidden_params.get("model_id", None) or ""
|
|
cache_key = hidden_params.get("cache_key", None) or ""
|
|
api_base = hidden_params.get("api_base", None) or ""
|
|
|
|
fastapi_response.headers.update(
|
|
ProxyBaseLLMRequestProcessing.get_custom_headers(
|
|
user_api_key_dict=user_api_key_dict,
|
|
model_id=model_id,
|
|
cache_key=cache_key,
|
|
api_base=api_base,
|
|
version=version,
|
|
model_region=getattr(user_api_key_dict, "allowed_model_region", ""),
|
|
request_data=data,
|
|
)
|
|
)
|
|
|
|
return response
|
|
except Exception as e:
|
|
await proxy_logging_obj.post_call_failure_hook(
|
|
user_api_key_dict=user_api_key_dict, original_exception=e, request_data=data
|
|
)
|
|
verbose_proxy_logger.exception(
|
|
"litellm.proxy.proxy_server.create_batch(): Exception occured - {}".format(
|
|
str(e)
|
|
)
|
|
)
|
|
raise handle_exception_on_proxy(e)
|
|
|
|
|
|
@router.get(
|
|
"/{provider}/v1/batches/{batch_id:path}",
|
|
dependencies=[Depends(user_api_key_auth)],
|
|
tags=["batch"],
|
|
)
|
|
@router.get(
|
|
"/v1/batches/{batch_id:path}",
|
|
dependencies=[Depends(user_api_key_auth)],
|
|
tags=["batch"],
|
|
)
|
|
@router.get(
|
|
"/batches/{batch_id:path}",
|
|
dependencies=[Depends(user_api_key_auth)],
|
|
tags=["batch"],
|
|
)
|
|
async def retrieve_batch( # noqa: PLR0915
|
|
request: Request,
|
|
fastapi_response: Response,
|
|
user_api_key_dict: UserAPIKeyAuth = Depends(user_api_key_auth),
|
|
provider: Optional[str] = None,
|
|
batch_id: str = Path(
|
|
title="Batch ID to retrieve", description="The ID of the batch to retrieve"
|
|
),
|
|
):
|
|
"""
|
|
Retrieves a batch.
|
|
This is the equivalent of GET https://api.openai.com/v1/batches/{batch_id}
|
|
Supports Identical Params as: https://platform.openai.com/docs/api-reference/batch/retrieve
|
|
|
|
Example Curl
|
|
```
|
|
curl http://localhost:4000/v1/batches/batch_abc123 \
|
|
-H "Authorization: Bearer sk-1234" \
|
|
-H "Content-Type: application/json" \
|
|
|
|
```
|
|
"""
|
|
from litellm.proxy.proxy_server import (
|
|
general_settings,
|
|
llm_router,
|
|
proxy_config,
|
|
proxy_logging_obj,
|
|
version,
|
|
)
|
|
|
|
data: Dict = {}
|
|
try:
|
|
model_from_id = decode_model_from_file_id(batch_id)
|
|
_retrieve_batch_request = RetrieveBatchRequest(
|
|
batch_id=batch_id,
|
|
)
|
|
|
|
data = cast(dict, _retrieve_batch_request)
|
|
unified_batch_id = _is_base64_encoded_unified_file_id(batch_id)
|
|
|
|
base_llm_response_processor = ProxyBaseLLMRequestProcessing(data=data)
|
|
(
|
|
data,
|
|
litellm_logging_obj,
|
|
) = await base_llm_response_processor.common_processing_pre_call_logic(
|
|
request=request,
|
|
general_settings=general_settings,
|
|
user_api_key_dict=user_api_key_dict,
|
|
version=version,
|
|
proxy_logging_obj=proxy_logging_obj,
|
|
proxy_config=proxy_config,
|
|
route_type="aretrieve_batch",
|
|
)
|
|
|
|
# FIX: First, try to read from ManagedObjectTable for consistent state
|
|
managed_files_obj = proxy_logging_obj.get_proxy_hook("managed_files")
|
|
from litellm.proxy.proxy_server import prisma_client
|
|
|
|
db_batch_object, response = await get_batch_from_database(
|
|
batch_id=batch_id,
|
|
unified_batch_id=unified_batch_id,
|
|
managed_files_obj=managed_files_obj,
|
|
prisma_client=prisma_client,
|
|
verbose_proxy_logger=verbose_proxy_logger,
|
|
)
|
|
|
|
# If batch is in a terminal state, return immediately
|
|
if response is not None and response.status in [
|
|
"completed",
|
|
"failed",
|
|
"cancelled",
|
|
"expired",
|
|
]:
|
|
# Call hooks and return
|
|
response = await proxy_logging_obj.post_call_success_hook(
|
|
data=data, user_api_key_dict=user_api_key_dict, response=response
|
|
)
|
|
|
|
# async_post_call_success_hook replaces batch.id and output_file_id with unified IDs
|
|
# but not input_file_id. Resolve raw provider ID to unified ID.
|
|
if unified_batch_id:
|
|
await resolve_input_file_id_to_unified(response, prisma_client)
|
|
|
|
asyncio.create_task(
|
|
proxy_logging_obj.update_request_status(
|
|
litellm_call_id=data.get("litellm_call_id", ""), status="success"
|
|
)
|
|
)
|
|
|
|
hidden_params = getattr(response, "_hidden_params", {}) or {}
|
|
model_id = hidden_params.get("model_id", None) or ""
|
|
cache_key = hidden_params.get("cache_key", None) or ""
|
|
api_base = hidden_params.get("api_base", None) or ""
|
|
|
|
fastapi_response.headers.update(
|
|
ProxyBaseLLMRequestProcessing.get_custom_headers(
|
|
user_api_key_dict=user_api_key_dict,
|
|
model_id=model_id,
|
|
cache_key=cache_key,
|
|
api_base=api_base,
|
|
version=version,
|
|
model_region=getattr(user_api_key_dict, "allowed_model_region", ""),
|
|
request_data=data,
|
|
)
|
|
)
|
|
|
|
return response
|
|
|
|
# If batch is still processing, sync with provider to get latest state
|
|
if response is not None:
|
|
verbose_proxy_logger.debug(
|
|
f"Batch {batch_id} is in non-terminal state {response.status}, syncing with provider"
|
|
)
|
|
|
|
# Retrieve from provider (for non-terminal states or if DB lookup failed)
|
|
# SCENARIO 1: Batch ID is encoded with model info
|
|
if model_from_id is not None:
|
|
credentials = get_credentials_for_model(
|
|
llm_router=llm_router,
|
|
model_id=model_from_id,
|
|
operation_context="batch retrieval (batch created with model)",
|
|
)
|
|
|
|
original_batch_id = get_original_file_id(batch_id)
|
|
prepare_data_with_credentials(
|
|
data=data,
|
|
credentials=credentials,
|
|
file_id=original_batch_id, # Sets data["batch_id"] = original_batch_id
|
|
)
|
|
# Fix: The helper sets "file_id" but we need "batch_id"
|
|
data["batch_id"] = data.pop("file_id", original_batch_id)
|
|
|
|
# Retrieve batch using model credentials
|
|
response = await litellm.aretrieve_batch(
|
|
custom_llm_provider=credentials["custom_llm_provider"],
|
|
**data, # type: ignore
|
|
)
|
|
|
|
encode_batch_response_ids(response, model=model_from_id)
|
|
|
|
verbose_proxy_logger.debug(
|
|
f"Retrieved batch using model: {model_from_id}, original_id: {original_batch_id}"
|
|
)
|
|
|
|
elif (
|
|
litellm.enable_loadbalancing_on_batch_endpoints is True or unified_batch_id
|
|
):
|
|
if llm_router is None:
|
|
raise HTTPException(
|
|
status_code=500,
|
|
detail={
|
|
"error": "LLM Router not initialized. Ensure models added to proxy."
|
|
},
|
|
)
|
|
|
|
response = await llm_router.aretrieve_batch(**data) # type: ignore
|
|
response._hidden_params["unified_batch_id"] = unified_batch_id
|
|
if unified_batch_id:
|
|
model_id_from_batch = get_model_id_from_unified_batch_id(
|
|
unified_batch_id
|
|
)
|
|
if model_id_from_batch:
|
|
response._hidden_params["model_id"] = model_id_from_batch
|
|
|
|
# SCENARIO 3: Fallback to custom_llm_provider (uses env variables)
|
|
else:
|
|
custom_llm_provider = (
|
|
provider
|
|
or get_custom_llm_provider_from_request_headers(request=request)
|
|
or get_custom_llm_provider_from_request_query(request=request)
|
|
or "openai"
|
|
)
|
|
response = await litellm.aretrieve_batch(
|
|
custom_llm_provider=custom_llm_provider, **data # type: ignore
|
|
)
|
|
|
|
# FIX: Update the database with the latest state from provider
|
|
await update_batch_in_database(
|
|
batch_id=batch_id,
|
|
unified_batch_id=unified_batch_id,
|
|
response=response,
|
|
managed_files_obj=managed_files_obj,
|
|
prisma_client=prisma_client,
|
|
verbose_proxy_logger=verbose_proxy_logger,
|
|
db_batch_object=db_batch_object,
|
|
operation="retrieve",
|
|
)
|
|
|
|
### CALL HOOKS ### - modify outgoing data
|
|
response = await proxy_logging_obj.post_call_success_hook(
|
|
data=data, user_api_key_dict=user_api_key_dict, response=response
|
|
)
|
|
|
|
# Fix: bug_feb14_batch_retrieve_returns_raw_input_file_id
|
|
# Resolve raw provider input_file_id to unified ID.
|
|
if unified_batch_id:
|
|
await resolve_input_file_id_to_unified(response, prisma_client)
|
|
|
|
### ALERTING ###
|
|
asyncio.create_task(
|
|
proxy_logging_obj.update_request_status(
|
|
litellm_call_id=data.get("litellm_call_id", ""), status="success"
|
|
)
|
|
)
|
|
|
|
### RESPONSE HEADERS ###
|
|
hidden_params = getattr(response, "_hidden_params", {}) or {}
|
|
model_id = hidden_params.get("model_id", None) or ""
|
|
cache_key = hidden_params.get("cache_key", None) or ""
|
|
api_base = hidden_params.get("api_base", None) or ""
|
|
|
|
fastapi_response.headers.update(
|
|
ProxyBaseLLMRequestProcessing.get_custom_headers(
|
|
user_api_key_dict=user_api_key_dict,
|
|
model_id=model_id,
|
|
cache_key=cache_key,
|
|
api_base=api_base,
|
|
version=version,
|
|
model_region=getattr(user_api_key_dict, "allowed_model_region", ""),
|
|
request_data=data,
|
|
)
|
|
)
|
|
|
|
return response
|
|
except Exception as e:
|
|
await proxy_logging_obj.post_call_failure_hook(
|
|
user_api_key_dict=user_api_key_dict, original_exception=e, request_data=data
|
|
)
|
|
verbose_proxy_logger.exception(
|
|
"litellm.proxy.proxy_server.retrieve_batch(): Exception occured - {}".format(
|
|
str(e)
|
|
)
|
|
)
|
|
raise handle_exception_on_proxy(e)
|
|
|
|
|
|
@router.get(
|
|
"/{provider}/v1/batches",
|
|
dependencies=[Depends(user_api_key_auth)],
|
|
tags=["batch"],
|
|
)
|
|
@router.get(
|
|
"/v1/batches",
|
|
dependencies=[Depends(user_api_key_auth)],
|
|
tags=["batch"],
|
|
)
|
|
@router.get(
|
|
"/batches",
|
|
dependencies=[Depends(user_api_key_auth)],
|
|
tags=["batch"],
|
|
)
|
|
async def list_batches(
|
|
request: Request,
|
|
fastapi_response: Response,
|
|
provider: Optional[str] = None,
|
|
limit: Optional[int] = None,
|
|
after: Optional[str] = None,
|
|
user_api_key_dict: UserAPIKeyAuth = Depends(user_api_key_auth),
|
|
target_model_names: Optional[str] = None,
|
|
):
|
|
"""
|
|
Lists
|
|
This is the equivalent of GET https://api.openai.com/v1/batches/
|
|
Supports Identical Params as: https://platform.openai.com/docs/api-reference/batch/list
|
|
|
|
Example Curl
|
|
```
|
|
curl http://localhost:4000/v1/batches?limit=2 \
|
|
-H "Authorization: Bearer sk-1234" \
|
|
-H "Content-Type: application/json" \
|
|
|
|
```
|
|
"""
|
|
from litellm.proxy.proxy_server import (
|
|
general_settings,
|
|
llm_router,
|
|
proxy_config,
|
|
proxy_logging_obj,
|
|
version,
|
|
)
|
|
|
|
verbose_proxy_logger.debug("GET /v1/batches after={} limit={}".format(after, limit))
|
|
try:
|
|
if llm_router is None:
|
|
raise HTTPException(
|
|
status_code=500,
|
|
detail={"error": CommonProxyErrors.no_llm_router.value},
|
|
)
|
|
|
|
# Include original request and headers in the data
|
|
data = await _read_request_body(request=request)
|
|
base_llm_response_processor = ProxyBaseLLMRequestProcessing(data=data)
|
|
(
|
|
data,
|
|
litellm_logging_obj,
|
|
) = await base_llm_response_processor.common_processing_pre_call_logic(
|
|
request=request,
|
|
general_settings=general_settings,
|
|
user_api_key_dict=user_api_key_dict,
|
|
version=version,
|
|
proxy_logging_obj=proxy_logging_obj,
|
|
proxy_config=proxy_config,
|
|
route_type="alist_batches",
|
|
)
|
|
|
|
# Try to use managed objects table for listing batches (returns encoded IDs)
|
|
managed_files_obj = proxy_logging_obj.get_proxy_hook("managed_files")
|
|
if managed_files_obj is not None and hasattr(
|
|
managed_files_obj, "list_user_batches"
|
|
):
|
|
verbose_proxy_logger.debug("Using managed objects table for batch listing")
|
|
response = await managed_files_obj.list_user_batches(
|
|
user_api_key_dict=user_api_key_dict,
|
|
limit=limit,
|
|
after=after,
|
|
provider=provider,
|
|
target_model_names=target_model_names,
|
|
llm_router=llm_router,
|
|
)
|
|
elif model_param := (
|
|
data.get("model")
|
|
or request.query_params.get("model")
|
|
or request.headers.get("x-litellm-model")
|
|
):
|
|
# SCENARIO 2: Use model-based routing from header/query/body
|
|
credentials = get_credentials_for_model(
|
|
llm_router=llm_router,
|
|
model_id=model_param,
|
|
operation_context="batch listing",
|
|
)
|
|
|
|
data.update(credentials)
|
|
|
|
response = await litellm.alist_batches(
|
|
custom_llm_provider=credentials["custom_llm_provider"],
|
|
after=after,
|
|
limit=limit,
|
|
**data, # type: ignore
|
|
)
|
|
|
|
# Encode batch IDs in the list response so clients can use
|
|
# them for retrieve/cancel/file downloads through the proxy.
|
|
if response and hasattr(response, "data") and response.data:
|
|
for batch in response.data:
|
|
encode_batch_response_ids(batch, model=model_param)
|
|
|
|
verbose_proxy_logger.debug(f"Listed batches using model: {model_param}")
|
|
|
|
# SCENARIO 2 (alternative): target_model_names based routing
|
|
elif target_model_names or data.get("target_model_names", None):
|
|
target_model_names = target_model_names or data.get(
|
|
"target_model_names", None
|
|
)
|
|
if target_model_names is None:
|
|
raise ValueError(
|
|
"target_model_names is required for this routing scenario"
|
|
)
|
|
model = target_model_names.split(",")[0]
|
|
data.pop("model", None)
|
|
response = await llm_router.alist_batches(
|
|
model=model,
|
|
after=after,
|
|
limit=limit,
|
|
**data,
|
|
)
|
|
|
|
# SCENARIO 3: Fallback to custom_llm_provider (uses env variables)
|
|
else:
|
|
custom_llm_provider = (
|
|
provider
|
|
or get_custom_llm_provider_from_request_headers(request=request)
|
|
or get_custom_llm_provider_from_request_query(request=request)
|
|
or "openai"
|
|
)
|
|
response = await litellm.alist_batches(
|
|
custom_llm_provider=custom_llm_provider, # type: ignore
|
|
after=after,
|
|
limit=limit,
|
|
**data,
|
|
)
|
|
|
|
## POST CALL HOOKS ###
|
|
_response = await proxy_logging_obj.post_call_success_hook(
|
|
data=data, user_api_key_dict=user_api_key_dict, response=response # type: ignore
|
|
)
|
|
if _response is not None and type(response) is type(_response):
|
|
response = _response
|
|
|
|
### RESPONSE HEADERS ###
|
|
hidden_params = getattr(response, "_hidden_params", {}) or {}
|
|
model_id = hidden_params.get("model_id", None) or ""
|
|
cache_key = hidden_params.get("cache_key", None) or ""
|
|
api_base = hidden_params.get("api_base", None) or ""
|
|
|
|
fastapi_response.headers.update(
|
|
ProxyBaseLLMRequestProcessing.get_custom_headers(
|
|
user_api_key_dict=user_api_key_dict,
|
|
model_id=model_id,
|
|
cache_key=cache_key,
|
|
api_base=api_base,
|
|
version=version,
|
|
model_region=getattr(user_api_key_dict, "allowed_model_region", ""),
|
|
)
|
|
)
|
|
|
|
return response
|
|
except Exception as e:
|
|
await proxy_logging_obj.post_call_failure_hook(
|
|
user_api_key_dict=user_api_key_dict,
|
|
original_exception=e,
|
|
request_data={"after": after, "limit": limit},
|
|
)
|
|
verbose_proxy_logger.error(
|
|
"litellm.proxy.proxy_server.retrieve_batch(): Exception occured - {}".format(
|
|
str(e)
|
|
)
|
|
)
|
|
raise handle_exception_on_proxy(e)
|
|
|
|
|
|
@router.post(
|
|
"/{provider}/v1/batches/{batch_id:path}/cancel",
|
|
dependencies=[Depends(user_api_key_auth)],
|
|
tags=["batch"],
|
|
)
|
|
@router.post(
|
|
"/v1/batches/{batch_id:path}/cancel",
|
|
dependencies=[Depends(user_api_key_auth)],
|
|
tags=["batch"],
|
|
)
|
|
@router.post(
|
|
"/batches/{batch_id:path}/cancel",
|
|
dependencies=[Depends(user_api_key_auth)],
|
|
tags=["batch"],
|
|
)
|
|
async def cancel_batch(
|
|
request: Request,
|
|
batch_id: str,
|
|
fastapi_response: Response,
|
|
provider: Optional[str] = None,
|
|
user_api_key_dict: UserAPIKeyAuth = Depends(user_api_key_auth),
|
|
):
|
|
"""
|
|
Cancel a batch.
|
|
This is the equivalent of POST https://api.openai.com/v1/batches/{batch_id}/cancel
|
|
|
|
Supports Identical Params as: https://platform.openai.com/docs/api-reference/batch/cancel
|
|
|
|
Example Curl
|
|
```
|
|
curl http://localhost:4000/v1/batches/batch_abc123/cancel \
|
|
-H "Authorization: Bearer sk-1234" \
|
|
-H "Content-Type: application/json" \
|
|
-X POST
|
|
|
|
```
|
|
"""
|
|
from litellm.proxy.proxy_server import (
|
|
add_litellm_data_to_request,
|
|
general_settings,
|
|
llm_router,
|
|
proxy_config,
|
|
proxy_logging_obj,
|
|
version,
|
|
)
|
|
|
|
data: Dict = {}
|
|
try:
|
|
# Check for encoded batch ID with model info
|
|
model_from_id = decode_model_from_file_id(batch_id)
|
|
|
|
# Create CancelBatchRequest with batch_id to enable ownership checking
|
|
_cancel_batch_request = CancelBatchRequest(
|
|
batch_id=batch_id,
|
|
)
|
|
data = cast(dict, _cancel_batch_request)
|
|
|
|
unified_batch_id = _is_base64_encoded_unified_file_id(batch_id)
|
|
|
|
base_llm_response_processor = ProxyBaseLLMRequestProcessing(data=data)
|
|
(
|
|
data,
|
|
litellm_logging_obj,
|
|
) = await base_llm_response_processor.common_processing_pre_call_logic(
|
|
request=request,
|
|
general_settings=general_settings,
|
|
user_api_key_dict=user_api_key_dict,
|
|
version=version,
|
|
proxy_logging_obj=proxy_logging_obj,
|
|
proxy_config=proxy_config,
|
|
route_type="acancel_batch",
|
|
)
|
|
|
|
# Include original request and headers in the data
|
|
data = await add_litellm_data_to_request(
|
|
data=data,
|
|
request=request,
|
|
general_settings=general_settings,
|
|
user_api_key_dict=user_api_key_dict,
|
|
version=version,
|
|
proxy_config=proxy_config,
|
|
)
|
|
|
|
# SCENARIO 1: Batch ID is encoded with model info
|
|
if model_from_id is not None:
|
|
credentials = get_credentials_for_model(
|
|
llm_router=llm_router,
|
|
model_id=model_from_id,
|
|
operation_context="batch cancellation (batch created with model)",
|
|
)
|
|
|
|
original_batch_id = get_original_file_id(batch_id)
|
|
prepare_data_with_credentials(
|
|
data=data,
|
|
credentials=credentials,
|
|
file_id=original_batch_id,
|
|
)
|
|
# Fix: The helper sets "file_id" but we need "batch_id"
|
|
data["batch_id"] = data.pop("file_id", original_batch_id)
|
|
|
|
# Cancel batch using model credentials
|
|
response = await litellm.acancel_batch(
|
|
custom_llm_provider=credentials["custom_llm_provider"],
|
|
**data, # type: ignore
|
|
)
|
|
|
|
encode_batch_response_ids(response, model=model_from_id)
|
|
|
|
verbose_proxy_logger.debug(
|
|
f"Cancelled batch using model: {model_from_id}, original_id: {original_batch_id}"
|
|
)
|
|
|
|
# SCENARIO 2: target_model_names based routing
|
|
elif unified_batch_id:
|
|
if llm_router is None:
|
|
raise HTTPException(
|
|
status_code=500,
|
|
detail={
|
|
"error": "LLM Router not initialized. Ensure models added to proxy."
|
|
},
|
|
)
|
|
|
|
# Hook has already extracted model and unwrapped batch_id into data dict
|
|
response = await llm_router.acancel_batch(**data) # type: ignore
|
|
response._hidden_params["unified_batch_id"] = unified_batch_id
|
|
|
|
# Ensure model_id is set for the post_call_success_hook to re-encode IDs
|
|
if not response._hidden_params.get("model_id") and data.get("model"):
|
|
response._hidden_params["model_id"] = data["model"]
|
|
|
|
# SCENARIO 3: Fallback to custom_llm_provider (uses env variables)
|
|
else:
|
|
custom_llm_provider = (
|
|
provider or data.pop("custom_llm_provider", None) or "openai"
|
|
)
|
|
# Extract batch_id from data to avoid "multiple values for keyword argument" error
|
|
# data was cast from CancelBatchRequest which already contains batch_id
|
|
data.pop("batch_id", None)
|
|
_cancel_batch_data = CancelBatchRequest(batch_id=batch_id, **data)
|
|
response = await litellm.acancel_batch(
|
|
custom_llm_provider=custom_llm_provider, # type: ignore
|
|
**_cancel_batch_data,
|
|
)
|
|
|
|
# FIX: Update the database with the new cancelled state
|
|
managed_files_obj = proxy_logging_obj.get_proxy_hook("managed_files")
|
|
from litellm.proxy.proxy_server import prisma_client
|
|
|
|
await update_batch_in_database(
|
|
batch_id=batch_id,
|
|
unified_batch_id=unified_batch_id,
|
|
response=response,
|
|
managed_files_obj=managed_files_obj,
|
|
prisma_client=prisma_client,
|
|
verbose_proxy_logger=verbose_proxy_logger,
|
|
operation="cancel",
|
|
)
|
|
|
|
### CALL HOOKS ### - modify outgoing data
|
|
response = await proxy_logging_obj.post_call_success_hook(
|
|
data=data, user_api_key_dict=user_api_key_dict, response=response
|
|
)
|
|
|
|
### ALERTING ###
|
|
asyncio.create_task(
|
|
proxy_logging_obj.update_request_status(
|
|
litellm_call_id=data.get("litellm_call_id", ""), status="success"
|
|
)
|
|
)
|
|
|
|
### RESPONSE HEADERS ###
|
|
hidden_params = getattr(response, "_hidden_params", {}) or {}
|
|
model_id = hidden_params.get("model_id", None) or ""
|
|
cache_key = hidden_params.get("cache_key", None) or ""
|
|
api_base = hidden_params.get("api_base", None) or ""
|
|
|
|
fastapi_response.headers.update(
|
|
ProxyBaseLLMRequestProcessing.get_custom_headers(
|
|
user_api_key_dict=user_api_key_dict,
|
|
model_id=model_id,
|
|
cache_key=cache_key,
|
|
api_base=api_base,
|
|
version=version,
|
|
model_region=getattr(user_api_key_dict, "allowed_model_region", ""),
|
|
request_data=data,
|
|
)
|
|
)
|
|
|
|
return response
|
|
except Exception as e:
|
|
await proxy_logging_obj.post_call_failure_hook(
|
|
user_api_key_dict=user_api_key_dict, original_exception=e, request_data=data
|
|
)
|
|
verbose_proxy_logger.exception(
|
|
"litellm.proxy.proxy_server.create_batch(): Exception occured - {}".format(
|
|
str(e)
|
|
)
|
|
)
|
|
raise handle_exception_on_proxy(e)
|
|
|
|
|
|
######################################################################
|
|
|
|
# END OF /v1/batches Endpoints Implementation
|
|
|
|
######################################################################
|