mirror of
https://github.com/meta-llama/llama-stack.git
synced 2025-12-11 19:56:03 +00:00
API change POST /test to GET /health
This commit is contained in:
Raghotham Murthy
parent
659e6ee86c
commit
0d8e27b461
8 changed files with 2548 additions and 2772 deletions
|
|
@ -15,178 +15,6 @@ info:
|
||||||
servers:
|
servers:
|
||||||
- url: http://any-hosted-llama-stack.com
|
- url: http://any-hosted-llama-stack.com
|
||||||
paths:
|
paths:
|
||||||
/v1/admin/providers/{api}:
|
|
||||||
post:
|
|
||||||
responses:
|
|
||||||
'200':
|
|
||||||
description: >-
|
|
||||||
RegisterProviderResponse with the registered provider info.
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
$ref: '#/components/schemas/RegisterProviderResponse'
|
|
||||||
'400':
|
|
||||||
$ref: '#/components/responses/BadRequest400'
|
|
||||||
'429':
|
|
||||||
$ref: >-
|
|
||||||
#/components/responses/TooManyRequests429
|
|
||||||
'500':
|
|
||||||
$ref: >-
|
|
||||||
#/components/responses/InternalServerError500
|
|
||||||
default:
|
|
||||||
$ref: '#/components/responses/DefaultError'
|
|
||||||
tags:
|
|
||||||
- Providers
|
|
||||||
summary: Register a new dynamic provider.
|
|
||||||
description: >-
|
|
||||||
Register a new dynamic provider.
|
|
||||||
|
|
||||||
Register a new provider instance at runtime. The provider will be validated,
|
|
||||||
|
|
||||||
instantiated, and persisted to the kvstore. Requires appropriate ABAC permissions.
|
|
||||||
parameters:
|
|
||||||
- name: api
|
|
||||||
in: path
|
|
||||||
description: >-
|
|
||||||
API namespace this provider implements (e.g., 'inference', 'vector_io').
|
|
||||||
required: true
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
requestBody:
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
$ref: '#/components/schemas/RegisterProviderRequest'
|
|
||||||
required: true
|
|
||||||
deprecated: false
|
|
||||||
/v1/admin/providers/{api}/{provider_id}:
|
|
||||||
post:
|
|
||||||
responses:
|
|
||||||
'200':
|
|
||||||
description: >-
|
|
||||||
UpdateProviderResponse with updated provider info
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
$ref: '#/components/schemas/UpdateProviderResponse'
|
|
||||||
'400':
|
|
||||||
$ref: '#/components/responses/BadRequest400'
|
|
||||||
'429':
|
|
||||||
$ref: >-
|
|
||||||
#/components/responses/TooManyRequests429
|
|
||||||
'500':
|
|
||||||
$ref: >-
|
|
||||||
#/components/responses/InternalServerError500
|
|
||||||
default:
|
|
||||||
$ref: '#/components/responses/DefaultError'
|
|
||||||
tags:
|
|
||||||
- Providers
|
|
||||||
summary: >-
|
|
||||||
Update an existing provider's configuration.
|
|
||||||
description: >-
|
|
||||||
Update an existing provider's configuration.
|
|
||||||
|
|
||||||
Update the configuration and/or attributes of a dynamic provider. The provider
|
|
||||||
|
|
||||||
will be re-instantiated with the new configuration (hot-reload).
|
|
||||||
parameters:
|
|
||||||
- name: api
|
|
||||||
in: path
|
|
||||||
description: API namespace the provider implements
|
|
||||||
required: true
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
- name: provider_id
|
|
||||||
in: path
|
|
||||||
description: ID of the provider to update
|
|
||||||
required: true
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
requestBody:
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
$ref: '#/components/schemas/UpdateProviderRequest'
|
|
||||||
required: true
|
|
||||||
deprecated: false
|
|
||||||
delete:
|
|
||||||
responses:
|
|
||||||
'200':
|
|
||||||
description: OK
|
|
||||||
'400':
|
|
||||||
$ref: '#/components/responses/BadRequest400'
|
|
||||||
'429':
|
|
||||||
$ref: >-
|
|
||||||
#/components/responses/TooManyRequests429
|
|
||||||
'500':
|
|
||||||
$ref: >-
|
|
||||||
#/components/responses/InternalServerError500
|
|
||||||
default:
|
|
||||||
$ref: '#/components/responses/DefaultError'
|
|
||||||
tags:
|
|
||||||
- Providers
|
|
||||||
summary: Unregister a dynamic provider.
|
|
||||||
description: >-
|
|
||||||
Unregister a dynamic provider.
|
|
||||||
|
|
||||||
Remove a dynamic provider, shutting down its instance and removing it from
|
|
||||||
|
|
||||||
the kvstore.
|
|
||||||
parameters:
|
|
||||||
- name: api
|
|
||||||
in: path
|
|
||||||
description: API namespace the provider implements
|
|
||||||
required: true
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
- name: provider_id
|
|
||||||
in: path
|
|
||||||
description: ID of the provider to unregister.
|
|
||||||
required: true
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
deprecated: false
|
|
||||||
/v1/admin/providers/{api}/{provider_id}/test:
|
|
||||||
post:
|
|
||||||
responses:
|
|
||||||
'200':
|
|
||||||
description: >-
|
|
||||||
TestProviderConnectionResponse with health status.
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
$ref: '#/components/schemas/TestProviderConnectionResponse'
|
|
||||||
'400':
|
|
||||||
$ref: '#/components/responses/BadRequest400'
|
|
||||||
'429':
|
|
||||||
$ref: >-
|
|
||||||
#/components/responses/TooManyRequests429
|
|
||||||
'500':
|
|
||||||
$ref: >-
|
|
||||||
#/components/responses/InternalServerError500
|
|
||||||
default:
|
|
||||||
$ref: '#/components/responses/DefaultError'
|
|
||||||
tags:
|
|
||||||
- Providers
|
|
||||||
summary: Test a provider connection.
|
|
||||||
description: >-
|
|
||||||
Test a provider connection.
|
|
||||||
|
|
||||||
Execute a health check on a provider to verify it is reachable and functioning.
|
|
||||||
parameters:
|
|
||||||
- name: api
|
|
||||||
in: path
|
|
||||||
description: API namespace the provider implements.
|
|
||||||
required: true
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
- name: provider_id
|
|
||||||
in: path
|
|
||||||
description: ID of the provider to test.
|
|
||||||
required: true
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
deprecated: false
|
|
||||||
/v1/chat/completions:
|
/v1/chat/completions:
|
||||||
get:
|
get:
|
||||||
responses:
|
responses:
|
||||||
|
|
@ -937,35 +765,6 @@ paths:
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
deprecated: false
|
deprecated: false
|
||||||
/v1/health:
|
|
||||||
get:
|
|
||||||
responses:
|
|
||||||
'200':
|
|
||||||
description: >-
|
|
||||||
Health information indicating if the service is operational.
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
$ref: '#/components/schemas/HealthInfo'
|
|
||||||
'400':
|
|
||||||
$ref: '#/components/responses/BadRequest400'
|
|
||||||
'429':
|
|
||||||
$ref: >-
|
|
||||||
#/components/responses/TooManyRequests429
|
|
||||||
'500':
|
|
||||||
$ref: >-
|
|
||||||
#/components/responses/InternalServerError500
|
|
||||||
default:
|
|
||||||
$ref: '#/components/responses/DefaultError'
|
|
||||||
tags:
|
|
||||||
- Inspect
|
|
||||||
summary: Get health status.
|
|
||||||
description: >-
|
|
||||||
Get health status.
|
|
||||||
|
|
||||||
Get the current health status of the service.
|
|
||||||
parameters: []
|
|
||||||
deprecated: false
|
|
||||||
/v1/inspect/routes:
|
/v1/inspect/routes:
|
||||||
get:
|
get:
|
||||||
responses:
|
responses:
|
||||||
|
|
@ -3390,6 +3189,178 @@ paths:
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
deprecated: false
|
deprecated: false
|
||||||
|
/v1alpha/admin/providers/{api}:
|
||||||
|
post:
|
||||||
|
responses:
|
||||||
|
'200':
|
||||||
|
description: >-
|
||||||
|
RegisterProviderResponse with the registered provider info.
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: '#/components/schemas/RegisterProviderResponse'
|
||||||
|
'400':
|
||||||
|
$ref: '#/components/responses/BadRequest400'
|
||||||
|
'429':
|
||||||
|
$ref: >-
|
||||||
|
#/components/responses/TooManyRequests429
|
||||||
|
'500':
|
||||||
|
$ref: >-
|
||||||
|
#/components/responses/InternalServerError500
|
||||||
|
default:
|
||||||
|
$ref: '#/components/responses/DefaultError'
|
||||||
|
tags:
|
||||||
|
- Providers
|
||||||
|
summary: Register a new dynamic provider.
|
||||||
|
description: >-
|
||||||
|
Register a new dynamic provider.
|
||||||
|
|
||||||
|
Register a new provider instance at runtime. The provider will be validated,
|
||||||
|
|
||||||
|
instantiated, and persisted to the kvstore. Requires appropriate ABAC permissions.
|
||||||
|
parameters:
|
||||||
|
- name: api
|
||||||
|
in: path
|
||||||
|
description: >-
|
||||||
|
API namespace this provider implements (e.g., 'inference', 'vector_io').
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
requestBody:
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: '#/components/schemas/RegisterProviderRequest'
|
||||||
|
required: true
|
||||||
|
deprecated: false
|
||||||
|
/v1alpha/admin/providers/{api}/{provider_id}:
|
||||||
|
post:
|
||||||
|
responses:
|
||||||
|
'200':
|
||||||
|
description: >-
|
||||||
|
UpdateProviderResponse with updated provider info
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: '#/components/schemas/UpdateProviderResponse'
|
||||||
|
'400':
|
||||||
|
$ref: '#/components/responses/BadRequest400'
|
||||||
|
'429':
|
||||||
|
$ref: >-
|
||||||
|
#/components/responses/TooManyRequests429
|
||||||
|
'500':
|
||||||
|
$ref: >-
|
||||||
|
#/components/responses/InternalServerError500
|
||||||
|
default:
|
||||||
|
$ref: '#/components/responses/DefaultError'
|
||||||
|
tags:
|
||||||
|
- Providers
|
||||||
|
summary: >-
|
||||||
|
Update an existing provider's configuration.
|
||||||
|
description: >-
|
||||||
|
Update an existing provider's configuration.
|
||||||
|
|
||||||
|
Update the configuration and/or attributes of a dynamic provider. The provider
|
||||||
|
|
||||||
|
will be re-instantiated with the new configuration (hot-reload).
|
||||||
|
parameters:
|
||||||
|
- name: api
|
||||||
|
in: path
|
||||||
|
description: API namespace the provider implements
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
- name: provider_id
|
||||||
|
in: path
|
||||||
|
description: ID of the provider to update
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
requestBody:
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: '#/components/schemas/UpdateProviderRequest'
|
||||||
|
required: true
|
||||||
|
deprecated: false
|
||||||
|
delete:
|
||||||
|
responses:
|
||||||
|
'200':
|
||||||
|
description: OK
|
||||||
|
'400':
|
||||||
|
$ref: '#/components/responses/BadRequest400'
|
||||||
|
'429':
|
||||||
|
$ref: >-
|
||||||
|
#/components/responses/TooManyRequests429
|
||||||
|
'500':
|
||||||
|
$ref: >-
|
||||||
|
#/components/responses/InternalServerError500
|
||||||
|
default:
|
||||||
|
$ref: '#/components/responses/DefaultError'
|
||||||
|
tags:
|
||||||
|
- Providers
|
||||||
|
summary: Unregister a dynamic provider.
|
||||||
|
description: >-
|
||||||
|
Unregister a dynamic provider.
|
||||||
|
|
||||||
|
Remove a dynamic provider, shutting down its instance and removing it from
|
||||||
|
|
||||||
|
the kvstore.
|
||||||
|
parameters:
|
||||||
|
- name: api
|
||||||
|
in: path
|
||||||
|
description: API namespace the provider implements
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
- name: provider_id
|
||||||
|
in: path
|
||||||
|
description: ID of the provider to unregister.
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
deprecated: false
|
||||||
|
/v1alpha/admin/providers/{api}/{provider_id}/health:
|
||||||
|
get:
|
||||||
|
responses:
|
||||||
|
'200':
|
||||||
|
description: >-
|
||||||
|
TestProviderConnectionResponse with health status.
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: '#/components/schemas/TestProviderConnectionResponse'
|
||||||
|
'400':
|
||||||
|
$ref: '#/components/responses/BadRequest400'
|
||||||
|
'429':
|
||||||
|
$ref: >-
|
||||||
|
#/components/responses/TooManyRequests429
|
||||||
|
'500':
|
||||||
|
$ref: >-
|
||||||
|
#/components/responses/InternalServerError500
|
||||||
|
default:
|
||||||
|
$ref: '#/components/responses/DefaultError'
|
||||||
|
tags:
|
||||||
|
- Inspect
|
||||||
|
summary: Check provider health.
|
||||||
|
description: >-
|
||||||
|
Check provider health.
|
||||||
|
|
||||||
|
Execute a health check on a provider to verify it is reachable and functioning.
|
||||||
|
parameters:
|
||||||
|
- name: api
|
||||||
|
in: path
|
||||||
|
description: API namespace the provider implements.
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
- name: provider_id
|
||||||
|
in: path
|
||||||
|
description: ID of the provider to check.
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
deprecated: false
|
||||||
/v1alpha/agents:
|
/v1alpha/agents:
|
||||||
get:
|
get:
|
||||||
responses:
|
responses:
|
||||||
|
|
@ -4426,273 +4397,6 @@ components:
|
||||||
title: Error
|
title: Error
|
||||||
description: >-
|
description: >-
|
||||||
Error response from the API. Roughly follows RFC 7807.
|
Error response from the API. Roughly follows RFC 7807.
|
||||||
RegisterProviderRequest:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
provider_id:
|
|
||||||
type: string
|
|
||||||
description: >-
|
|
||||||
Unique identifier for this provider instance.
|
|
||||||
provider_type:
|
|
||||||
type: string
|
|
||||||
description: Provider type (e.g., 'remote::openai').
|
|
||||||
config:
|
|
||||||
type: object
|
|
||||||
additionalProperties:
|
|
||||||
oneOf:
|
|
||||||
- type: 'null'
|
|
||||||
- type: boolean
|
|
||||||
- type: number
|
|
||||||
- type: string
|
|
||||||
- type: array
|
|
||||||
- type: object
|
|
||||||
description: >-
|
|
||||||
Provider configuration (API keys, endpoints, etc.).
|
|
||||||
attributes:
|
|
||||||
type: object
|
|
||||||
additionalProperties:
|
|
||||||
type: array
|
|
||||||
items:
|
|
||||||
type: string
|
|
||||||
description: >-
|
|
||||||
Optional attributes for ABAC access control.
|
|
||||||
additionalProperties: false
|
|
||||||
required:
|
|
||||||
- provider_id
|
|
||||||
- provider_type
|
|
||||||
- config
|
|
||||||
title: RegisterProviderRequest
|
|
||||||
ProviderConnectionInfo:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
provider_id:
|
|
||||||
type: string
|
|
||||||
description: >-
|
|
||||||
Unique identifier for this provider instance
|
|
||||||
api:
|
|
||||||
type: string
|
|
||||||
description: >-
|
|
||||||
API namespace (e.g., "inference", "vector_io", "safety")
|
|
||||||
provider_type:
|
|
||||||
type: string
|
|
||||||
description: >-
|
|
||||||
Provider type identifier (e.g., "remote::openai", "inline::faiss")
|
|
||||||
config:
|
|
||||||
type: object
|
|
||||||
additionalProperties:
|
|
||||||
oneOf:
|
|
||||||
- type: 'null'
|
|
||||||
- type: boolean
|
|
||||||
- type: number
|
|
||||||
- type: string
|
|
||||||
- type: array
|
|
||||||
- type: object
|
|
||||||
description: >-
|
|
||||||
Provider-specific configuration (API keys, endpoints, etc.)
|
|
||||||
status:
|
|
||||||
$ref: '#/components/schemas/ProviderConnectionStatus'
|
|
||||||
description: Current connection status
|
|
||||||
health:
|
|
||||||
$ref: '#/components/schemas/ProviderHealth'
|
|
||||||
description: Most recent health check result
|
|
||||||
created_at:
|
|
||||||
type: string
|
|
||||||
format: date-time
|
|
||||||
description: Timestamp when provider was registered
|
|
||||||
updated_at:
|
|
||||||
type: string
|
|
||||||
format: date-time
|
|
||||||
description: Timestamp of last update
|
|
||||||
last_health_check:
|
|
||||||
type: string
|
|
||||||
format: date-time
|
|
||||||
description: Timestamp of last health check
|
|
||||||
error_message:
|
|
||||||
type: string
|
|
||||||
description: Error message if status is failed
|
|
||||||
metadata:
|
|
||||||
type: object
|
|
||||||
additionalProperties:
|
|
||||||
oneOf:
|
|
||||||
- type: 'null'
|
|
||||||
- type: boolean
|
|
||||||
- type: number
|
|
||||||
- type: string
|
|
||||||
- type: array
|
|
||||||
- type: object
|
|
||||||
description: >-
|
|
||||||
User-defined metadata (deprecated, use attributes)
|
|
||||||
owner:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
principal:
|
|
||||||
type: string
|
|
||||||
attributes:
|
|
||||||
type: object
|
|
||||||
additionalProperties:
|
|
||||||
type: array
|
|
||||||
items:
|
|
||||||
type: string
|
|
||||||
additionalProperties: false
|
|
||||||
required:
|
|
||||||
- principal
|
|
||||||
description: >-
|
|
||||||
User who created this provider connection
|
|
||||||
attributes:
|
|
||||||
type: object
|
|
||||||
additionalProperties:
|
|
||||||
type: array
|
|
||||||
items:
|
|
||||||
type: string
|
|
||||||
description: >-
|
|
||||||
Key-value attributes for ABAC access control
|
|
||||||
additionalProperties: false
|
|
||||||
required:
|
|
||||||
- provider_id
|
|
||||||
- api
|
|
||||||
- provider_type
|
|
||||||
- config
|
|
||||||
- status
|
|
||||||
- created_at
|
|
||||||
- updated_at
|
|
||||||
- metadata
|
|
||||||
title: ProviderConnectionInfo
|
|
||||||
description: >-
|
|
||||||
Information about a dynamically managed provider connection.
|
|
||||||
|
|
||||||
This model represents a provider that has been registered at runtime
|
|
||||||
|
|
||||||
via the /providers API, as opposed to static providers configured in run.yaml.
|
|
||||||
|
|
||||||
|
|
||||||
Dynamic providers support full lifecycle management including registration,
|
|
||||||
|
|
||||||
configuration updates, health monitoring, and removal.
|
|
||||||
ProviderConnectionStatus:
|
|
||||||
type: string
|
|
||||||
enum:
|
|
||||||
- pending
|
|
||||||
- initializing
|
|
||||||
- connected
|
|
||||||
- failed
|
|
||||||
- disconnected
|
|
||||||
- testing
|
|
||||||
title: ProviderConnectionStatus
|
|
||||||
description: Status of a dynamic provider connection.
|
|
||||||
ProviderHealth:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
status:
|
|
||||||
type: string
|
|
||||||
enum:
|
|
||||||
- OK
|
|
||||||
- Error
|
|
||||||
- Not Implemented
|
|
||||||
description: >-
|
|
||||||
Health status (OK, ERROR, NOT_IMPLEMENTED)
|
|
||||||
message:
|
|
||||||
type: string
|
|
||||||
description: Optional error or status message
|
|
||||||
metrics:
|
|
||||||
type: object
|
|
||||||
additionalProperties:
|
|
||||||
oneOf:
|
|
||||||
- type: 'null'
|
|
||||||
- type: boolean
|
|
||||||
- type: number
|
|
||||||
- type: string
|
|
||||||
- type: array
|
|
||||||
- type: object
|
|
||||||
description: Provider-specific health metrics
|
|
||||||
last_checked:
|
|
||||||
type: string
|
|
||||||
format: date-time
|
|
||||||
description: Timestamp of last health check
|
|
||||||
additionalProperties: false
|
|
||||||
required:
|
|
||||||
- status
|
|
||||||
- metrics
|
|
||||||
- last_checked
|
|
||||||
title: ProviderHealth
|
|
||||||
description: >-
|
|
||||||
Structured wrapper around provider health status.
|
|
||||||
|
|
||||||
This wraps the existing dict-based HealthResponse for API responses
|
|
||||||
|
|
||||||
while maintaining backward compatibility with existing provider implementations.
|
|
||||||
RegisterProviderResponse:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
provider:
|
|
||||||
$ref: '#/components/schemas/ProviderConnectionInfo'
|
|
||||||
description: >-
|
|
||||||
Information about the registered provider
|
|
||||||
additionalProperties: false
|
|
||||||
required:
|
|
||||||
- provider
|
|
||||||
title: RegisterProviderResponse
|
|
||||||
description: Response after registering a provider.
|
|
||||||
UpdateProviderRequest:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
config:
|
|
||||||
type: object
|
|
||||||
additionalProperties:
|
|
||||||
oneOf:
|
|
||||||
- type: 'null'
|
|
||||||
- type: boolean
|
|
||||||
- type: number
|
|
||||||
- type: string
|
|
||||||
- type: array
|
|
||||||
- type: object
|
|
||||||
description: >-
|
|
||||||
New configuration parameters (merged with existing)
|
|
||||||
attributes:
|
|
||||||
type: object
|
|
||||||
additionalProperties:
|
|
||||||
type: array
|
|
||||||
items:
|
|
||||||
type: string
|
|
||||||
description: New attributes for access control
|
|
||||||
additionalProperties: false
|
|
||||||
title: UpdateProviderRequest
|
|
||||||
UpdateProviderResponse:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
provider:
|
|
||||||
$ref: '#/components/schemas/ProviderConnectionInfo'
|
|
||||||
description: Updated provider information
|
|
||||||
additionalProperties: false
|
|
||||||
required:
|
|
||||||
- provider
|
|
||||||
title: UpdateProviderResponse
|
|
||||||
description: Response after updating a provider.
|
|
||||||
TestProviderConnectionResponse:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
success:
|
|
||||||
type: boolean
|
|
||||||
description: Whether the connection test succeeded
|
|
||||||
health:
|
|
||||||
type: object
|
|
||||||
additionalProperties:
|
|
||||||
oneOf:
|
|
||||||
- type: 'null'
|
|
||||||
- type: boolean
|
|
||||||
- type: number
|
|
||||||
- type: string
|
|
||||||
- type: array
|
|
||||||
- type: object
|
|
||||||
description: Health status from the provider
|
|
||||||
error_message:
|
|
||||||
type: string
|
|
||||||
description: Error message if test failed
|
|
||||||
additionalProperties: false
|
|
||||||
required:
|
|
||||||
- success
|
|
||||||
title: TestProviderConnectionResponse
|
|
||||||
description: >-
|
|
||||||
Response from testing a provider connection.
|
|
||||||
Order:
|
Order:
|
||||||
type: string
|
type: string
|
||||||
enum:
|
enum:
|
||||||
|
|
@ -6746,22 +6450,6 @@ components:
|
||||||
Response:
|
Response:
|
||||||
type: object
|
type: object
|
||||||
title: Response
|
title: Response
|
||||||
HealthInfo:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
status:
|
|
||||||
type: string
|
|
||||||
enum:
|
|
||||||
- OK
|
|
||||||
- Error
|
|
||||||
- Not Implemented
|
|
||||||
description: Current health status of the service
|
|
||||||
additionalProperties: false
|
|
||||||
required:
|
|
||||||
- status
|
|
||||||
title: HealthInfo
|
|
||||||
description: >-
|
|
||||||
Health status information for the service.
|
|
||||||
RouteInfo:
|
RouteInfo:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
|
|
@ -11876,6 +11564,273 @@ components:
|
||||||
- purpose
|
- purpose
|
||||||
- source
|
- source
|
||||||
title: RegisterDatasetRequest
|
title: RegisterDatasetRequest
|
||||||
|
RegisterProviderRequest:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
provider_id:
|
||||||
|
type: string
|
||||||
|
description: >-
|
||||||
|
Unique identifier for this provider instance.
|
||||||
|
provider_type:
|
||||||
|
type: string
|
||||||
|
description: Provider type (e.g., 'remote::openai').
|
||||||
|
config:
|
||||||
|
type: object
|
||||||
|
additionalProperties:
|
||||||
|
oneOf:
|
||||||
|
- type: 'null'
|
||||||
|
- type: boolean
|
||||||
|
- type: number
|
||||||
|
- type: string
|
||||||
|
- type: array
|
||||||
|
- type: object
|
||||||
|
description: >-
|
||||||
|
Provider configuration (API keys, endpoints, etc.).
|
||||||
|
attributes:
|
||||||
|
type: object
|
||||||
|
additionalProperties:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
description: >-
|
||||||
|
Optional attributes for ABAC access control.
|
||||||
|
additionalProperties: false
|
||||||
|
required:
|
||||||
|
- provider_id
|
||||||
|
- provider_type
|
||||||
|
- config
|
||||||
|
title: RegisterProviderRequest
|
||||||
|
ProviderConnectionInfo:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
provider_id:
|
||||||
|
type: string
|
||||||
|
description: >-
|
||||||
|
Unique identifier for this provider instance
|
||||||
|
api:
|
||||||
|
type: string
|
||||||
|
description: >-
|
||||||
|
API namespace (e.g., "inference", "vector_io", "safety")
|
||||||
|
provider_type:
|
||||||
|
type: string
|
||||||
|
description: >-
|
||||||
|
Provider type identifier (e.g., "remote::openai", "inline::faiss")
|
||||||
|
config:
|
||||||
|
type: object
|
||||||
|
additionalProperties:
|
||||||
|
oneOf:
|
||||||
|
- type: 'null'
|
||||||
|
- type: boolean
|
||||||
|
- type: number
|
||||||
|
- type: string
|
||||||
|
- type: array
|
||||||
|
- type: object
|
||||||
|
description: >-
|
||||||
|
Provider-specific configuration (API keys, endpoints, etc.)
|
||||||
|
status:
|
||||||
|
$ref: '#/components/schemas/ProviderConnectionStatus'
|
||||||
|
description: Current connection status
|
||||||
|
health:
|
||||||
|
$ref: '#/components/schemas/ProviderHealth'
|
||||||
|
description: Most recent health check result
|
||||||
|
created_at:
|
||||||
|
type: string
|
||||||
|
format: date-time
|
||||||
|
description: Timestamp when provider was registered
|
||||||
|
updated_at:
|
||||||
|
type: string
|
||||||
|
format: date-time
|
||||||
|
description: Timestamp of last update
|
||||||
|
last_health_check:
|
||||||
|
type: string
|
||||||
|
format: date-time
|
||||||
|
description: Timestamp of last health check
|
||||||
|
error_message:
|
||||||
|
type: string
|
||||||
|
description: Error message if status is failed
|
||||||
|
metadata:
|
||||||
|
type: object
|
||||||
|
additionalProperties:
|
||||||
|
oneOf:
|
||||||
|
- type: 'null'
|
||||||
|
- type: boolean
|
||||||
|
- type: number
|
||||||
|
- type: string
|
||||||
|
- type: array
|
||||||
|
- type: object
|
||||||
|
description: >-
|
||||||
|
User-defined metadata (deprecated, use attributes)
|
||||||
|
owner:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
principal:
|
||||||
|
type: string
|
||||||
|
attributes:
|
||||||
|
type: object
|
||||||
|
additionalProperties:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
additionalProperties: false
|
||||||
|
required:
|
||||||
|
- principal
|
||||||
|
description: >-
|
||||||
|
User who created this provider connection
|
||||||
|
attributes:
|
||||||
|
type: object
|
||||||
|
additionalProperties:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
description: >-
|
||||||
|
Key-value attributes for ABAC access control
|
||||||
|
additionalProperties: false
|
||||||
|
required:
|
||||||
|
- provider_id
|
||||||
|
- api
|
||||||
|
- provider_type
|
||||||
|
- config
|
||||||
|
- status
|
||||||
|
- created_at
|
||||||
|
- updated_at
|
||||||
|
- metadata
|
||||||
|
title: ProviderConnectionInfo
|
||||||
|
description: >-
|
||||||
|
Information about a dynamically managed provider connection.
|
||||||
|
|
||||||
|
This model represents a provider that has been registered at runtime
|
||||||
|
|
||||||
|
via the /providers API, as opposed to static providers configured in run.yaml.
|
||||||
|
|
||||||
|
|
||||||
|
Dynamic providers support full lifecycle management including registration,
|
||||||
|
|
||||||
|
configuration updates, health monitoring, and removal.
|
||||||
|
ProviderConnectionStatus:
|
||||||
|
type: string
|
||||||
|
enum:
|
||||||
|
- pending
|
||||||
|
- initializing
|
||||||
|
- connected
|
||||||
|
- failed
|
||||||
|
- disconnected
|
||||||
|
- testing
|
||||||
|
title: ProviderConnectionStatus
|
||||||
|
description: Status of a dynamic provider connection.
|
||||||
|
ProviderHealth:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
status:
|
||||||
|
type: string
|
||||||
|
enum:
|
||||||
|
- OK
|
||||||
|
- Error
|
||||||
|
- Not Implemented
|
||||||
|
description: >-
|
||||||
|
Health status (OK, ERROR, NOT_IMPLEMENTED)
|
||||||
|
message:
|
||||||
|
type: string
|
||||||
|
description: Optional error or status message
|
||||||
|
metrics:
|
||||||
|
type: object
|
||||||
|
additionalProperties:
|
||||||
|
oneOf:
|
||||||
|
- type: 'null'
|
||||||
|
- type: boolean
|
||||||
|
- type: number
|
||||||
|
- type: string
|
||||||
|
- type: array
|
||||||
|
- type: object
|
||||||
|
description: Provider-specific health metrics
|
||||||
|
last_checked:
|
||||||
|
type: string
|
||||||
|
format: date-time
|
||||||
|
description: Timestamp of last health check
|
||||||
|
additionalProperties: false
|
||||||
|
required:
|
||||||
|
- status
|
||||||
|
- metrics
|
||||||
|
- last_checked
|
||||||
|
title: ProviderHealth
|
||||||
|
description: >-
|
||||||
|
Structured wrapper around provider health status.
|
||||||
|
|
||||||
|
This wraps the existing dict-based HealthResponse for API responses
|
||||||
|
|
||||||
|
while maintaining backward compatibility with existing provider implementations.
|
||||||
|
RegisterProviderResponse:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
provider:
|
||||||
|
$ref: '#/components/schemas/ProviderConnectionInfo'
|
||||||
|
description: >-
|
||||||
|
Information about the registered provider
|
||||||
|
additionalProperties: false
|
||||||
|
required:
|
||||||
|
- provider
|
||||||
|
title: RegisterProviderResponse
|
||||||
|
description: Response after registering a provider.
|
||||||
|
UpdateProviderRequest:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
config:
|
||||||
|
type: object
|
||||||
|
additionalProperties:
|
||||||
|
oneOf:
|
||||||
|
- type: 'null'
|
||||||
|
- type: boolean
|
||||||
|
- type: number
|
||||||
|
- type: string
|
||||||
|
- type: array
|
||||||
|
- type: object
|
||||||
|
description: >-
|
||||||
|
New configuration parameters (merged with existing)
|
||||||
|
attributes:
|
||||||
|
type: object
|
||||||
|
additionalProperties:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
description: New attributes for access control
|
||||||
|
additionalProperties: false
|
||||||
|
title: UpdateProviderRequest
|
||||||
|
UpdateProviderResponse:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
provider:
|
||||||
|
$ref: '#/components/schemas/ProviderConnectionInfo'
|
||||||
|
description: Updated provider information
|
||||||
|
additionalProperties: false
|
||||||
|
required:
|
||||||
|
- provider
|
||||||
|
title: UpdateProviderResponse
|
||||||
|
description: Response after updating a provider.
|
||||||
|
TestProviderConnectionResponse:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
success:
|
||||||
|
type: boolean
|
||||||
|
description: Whether the connection test succeeded
|
||||||
|
health:
|
||||||
|
type: object
|
||||||
|
additionalProperties:
|
||||||
|
oneOf:
|
||||||
|
- type: 'null'
|
||||||
|
- type: boolean
|
||||||
|
- type: number
|
||||||
|
- type: string
|
||||||
|
- type: array
|
||||||
|
- type: object
|
||||||
|
description: Health status from the provider
|
||||||
|
error_message:
|
||||||
|
type: string
|
||||||
|
description: Error message if test failed
|
||||||
|
additionalProperties: false
|
||||||
|
required:
|
||||||
|
- success
|
||||||
|
title: TestProviderConnectionResponse
|
||||||
|
description: >-
|
||||||
|
Response from testing a provider connection.
|
||||||
AgentConfig:
|
AgentConfig:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
|
|
|
||||||
617
docs/static/experimental-llama-stack-spec.html
vendored
617
docs/static/experimental-llama-stack-spec.html
vendored
|
|
@ -310,6 +310,224 @@
|
||||||
"deprecated": false
|
"deprecated": false
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"/v1alpha/admin/providers/{api}": {
|
||||||
|
"post": {
|
||||||
|
"responses": {
|
||||||
|
"200": {
|
||||||
|
"description": "RegisterProviderResponse with the registered provider info.",
|
||||||
|
"content": {
|
||||||
|
"application/json": {
|
||||||
|
"schema": {
|
||||||
|
"$ref": "#/components/schemas/RegisterProviderResponse"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"400": {
|
||||||
|
"$ref": "#/components/responses/BadRequest400"
|
||||||
|
},
|
||||||
|
"429": {
|
||||||
|
"$ref": "#/components/responses/TooManyRequests429"
|
||||||
|
},
|
||||||
|
"500": {
|
||||||
|
"$ref": "#/components/responses/InternalServerError500"
|
||||||
|
},
|
||||||
|
"default": {
|
||||||
|
"$ref": "#/components/responses/DefaultError"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"tags": [
|
||||||
|
"Providers"
|
||||||
|
],
|
||||||
|
"summary": "Register a new dynamic provider.",
|
||||||
|
"description": "Register a new dynamic provider.\nRegister a new provider instance at runtime. The provider will be validated,\ninstantiated, and persisted to the kvstore. Requires appropriate ABAC permissions.",
|
||||||
|
"parameters": [
|
||||||
|
{
|
||||||
|
"name": "api",
|
||||||
|
"in": "path",
|
||||||
|
"description": "API namespace this provider implements (e.g., 'inference', 'vector_io').",
|
||||||
|
"required": true,
|
||||||
|
"schema": {
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"requestBody": {
|
||||||
|
"content": {
|
||||||
|
"application/json": {
|
||||||
|
"schema": {
|
||||||
|
"$ref": "#/components/schemas/RegisterProviderRequest"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"required": true
|
||||||
|
},
|
||||||
|
"deprecated": false
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"/v1alpha/admin/providers/{api}/{provider_id}": {
|
||||||
|
"post": {
|
||||||
|
"responses": {
|
||||||
|
"200": {
|
||||||
|
"description": "UpdateProviderResponse with updated provider info",
|
||||||
|
"content": {
|
||||||
|
"application/json": {
|
||||||
|
"schema": {
|
||||||
|
"$ref": "#/components/schemas/UpdateProviderResponse"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"400": {
|
||||||
|
"$ref": "#/components/responses/BadRequest400"
|
||||||
|
},
|
||||||
|
"429": {
|
||||||
|
"$ref": "#/components/responses/TooManyRequests429"
|
||||||
|
},
|
||||||
|
"500": {
|
||||||
|
"$ref": "#/components/responses/InternalServerError500"
|
||||||
|
},
|
||||||
|
"default": {
|
||||||
|
"$ref": "#/components/responses/DefaultError"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"tags": [
|
||||||
|
"Providers"
|
||||||
|
],
|
||||||
|
"summary": "Update an existing provider's configuration.",
|
||||||
|
"description": "Update an existing provider's configuration.\nUpdate the configuration and/or attributes of a dynamic provider. The provider\nwill be re-instantiated with the new configuration (hot-reload).",
|
||||||
|
"parameters": [
|
||||||
|
{
|
||||||
|
"name": "api",
|
||||||
|
"in": "path",
|
||||||
|
"description": "API namespace the provider implements",
|
||||||
|
"required": true,
|
||||||
|
"schema": {
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "provider_id",
|
||||||
|
"in": "path",
|
||||||
|
"description": "ID of the provider to update",
|
||||||
|
"required": true,
|
||||||
|
"schema": {
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"requestBody": {
|
||||||
|
"content": {
|
||||||
|
"application/json": {
|
||||||
|
"schema": {
|
||||||
|
"$ref": "#/components/schemas/UpdateProviderRequest"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"required": true
|
||||||
|
},
|
||||||
|
"deprecated": false
|
||||||
|
},
|
||||||
|
"delete": {
|
||||||
|
"responses": {
|
||||||
|
"200": {
|
||||||
|
"description": "OK"
|
||||||
|
},
|
||||||
|
"400": {
|
||||||
|
"$ref": "#/components/responses/BadRequest400"
|
||||||
|
},
|
||||||
|
"429": {
|
||||||
|
"$ref": "#/components/responses/TooManyRequests429"
|
||||||
|
},
|
||||||
|
"500": {
|
||||||
|
"$ref": "#/components/responses/InternalServerError500"
|
||||||
|
},
|
||||||
|
"default": {
|
||||||
|
"$ref": "#/components/responses/DefaultError"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"tags": [
|
||||||
|
"Providers"
|
||||||
|
],
|
||||||
|
"summary": "Unregister a dynamic provider.",
|
||||||
|
"description": "Unregister a dynamic provider.\nRemove a dynamic provider, shutting down its instance and removing it from\nthe kvstore.",
|
||||||
|
"parameters": [
|
||||||
|
{
|
||||||
|
"name": "api",
|
||||||
|
"in": "path",
|
||||||
|
"description": "API namespace the provider implements",
|
||||||
|
"required": true,
|
||||||
|
"schema": {
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "provider_id",
|
||||||
|
"in": "path",
|
||||||
|
"description": "ID of the provider to unregister.",
|
||||||
|
"required": true,
|
||||||
|
"schema": {
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"deprecated": false
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"/v1alpha/admin/providers/{api}/{provider_id}/health": {
|
||||||
|
"get": {
|
||||||
|
"responses": {
|
||||||
|
"200": {
|
||||||
|
"description": "TestProviderConnectionResponse with health status.",
|
||||||
|
"content": {
|
||||||
|
"application/json": {
|
||||||
|
"schema": {
|
||||||
|
"$ref": "#/components/schemas/TestProviderConnectionResponse"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"400": {
|
||||||
|
"$ref": "#/components/responses/BadRequest400"
|
||||||
|
},
|
||||||
|
"429": {
|
||||||
|
"$ref": "#/components/responses/TooManyRequests429"
|
||||||
|
},
|
||||||
|
"500": {
|
||||||
|
"$ref": "#/components/responses/InternalServerError500"
|
||||||
|
},
|
||||||
|
"default": {
|
||||||
|
"$ref": "#/components/responses/DefaultError"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"tags": [
|
||||||
|
"Inspect"
|
||||||
|
],
|
||||||
|
"summary": "Check provider health.",
|
||||||
|
"description": "Check provider health.\nExecute a health check on a provider to verify it is reachable and functioning.",
|
||||||
|
"parameters": [
|
||||||
|
{
|
||||||
|
"name": "api",
|
||||||
|
"in": "path",
|
||||||
|
"description": "API namespace the provider implements.",
|
||||||
|
"required": true,
|
||||||
|
"schema": {
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "provider_id",
|
||||||
|
"in": "path",
|
||||||
|
"description": "ID of the provider to check.",
|
||||||
|
"required": true,
|
||||||
|
"schema": {
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"deprecated": false
|
||||||
|
}
|
||||||
|
},
|
||||||
"/v1alpha/agents": {
|
"/v1alpha/agents": {
|
||||||
"get": {
|
"get": {
|
||||||
"responses": {
|
"responses": {
|
||||||
|
|
@ -2084,6 +2302,391 @@
|
||||||
],
|
],
|
||||||
"title": "RegisterDatasetRequest"
|
"title": "RegisterDatasetRequest"
|
||||||
},
|
},
|
||||||
|
"RegisterProviderRequest": {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"provider_id": {
|
||||||
|
"type": "string",
|
||||||
|
"description": "Unique identifier for this provider instance."
|
||||||
|
},
|
||||||
|
"provider_type": {
|
||||||
|
"type": "string",
|
||||||
|
"description": "Provider type (e.g., 'remote::openai')."
|
||||||
|
},
|
||||||
|
"config": {
|
||||||
|
"type": "object",
|
||||||
|
"additionalProperties": {
|
||||||
|
"oneOf": [
|
||||||
|
{
|
||||||
|
"type": "null"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "boolean"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "number"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "array"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "object"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"description": "Provider configuration (API keys, endpoints, etc.)."
|
||||||
|
},
|
||||||
|
"attributes": {
|
||||||
|
"type": "object",
|
||||||
|
"additionalProperties": {
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"description": "Optional attributes for ABAC access control."
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"additionalProperties": false,
|
||||||
|
"required": [
|
||||||
|
"provider_id",
|
||||||
|
"provider_type",
|
||||||
|
"config"
|
||||||
|
],
|
||||||
|
"title": "RegisterProviderRequest"
|
||||||
|
},
|
||||||
|
"ProviderConnectionInfo": {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"provider_id": {
|
||||||
|
"type": "string",
|
||||||
|
"description": "Unique identifier for this provider instance"
|
||||||
|
},
|
||||||
|
"api": {
|
||||||
|
"type": "string",
|
||||||
|
"description": "API namespace (e.g., \"inference\", \"vector_io\", \"safety\")"
|
||||||
|
},
|
||||||
|
"provider_type": {
|
||||||
|
"type": "string",
|
||||||
|
"description": "Provider type identifier (e.g., \"remote::openai\", \"inline::faiss\")"
|
||||||
|
},
|
||||||
|
"config": {
|
||||||
|
"type": "object",
|
||||||
|
"additionalProperties": {
|
||||||
|
"oneOf": [
|
||||||
|
{
|
||||||
|
"type": "null"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "boolean"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "number"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "array"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "object"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"description": "Provider-specific configuration (API keys, endpoints, etc.)"
|
||||||
|
},
|
||||||
|
"status": {
|
||||||
|
"$ref": "#/components/schemas/ProviderConnectionStatus",
|
||||||
|
"description": "Current connection status"
|
||||||
|
},
|
||||||
|
"health": {
|
||||||
|
"$ref": "#/components/schemas/ProviderHealth",
|
||||||
|
"description": "Most recent health check result"
|
||||||
|
},
|
||||||
|
"created_at": {
|
||||||
|
"type": "string",
|
||||||
|
"format": "date-time",
|
||||||
|
"description": "Timestamp when provider was registered"
|
||||||
|
},
|
||||||
|
"updated_at": {
|
||||||
|
"type": "string",
|
||||||
|
"format": "date-time",
|
||||||
|
"description": "Timestamp of last update"
|
||||||
|
},
|
||||||
|
"last_health_check": {
|
||||||
|
"type": "string",
|
||||||
|
"format": "date-time",
|
||||||
|
"description": "Timestamp of last health check"
|
||||||
|
},
|
||||||
|
"error_message": {
|
||||||
|
"type": "string",
|
||||||
|
"description": "Error message if status is failed"
|
||||||
|
},
|
||||||
|
"metadata": {
|
||||||
|
"type": "object",
|
||||||
|
"additionalProperties": {
|
||||||
|
"oneOf": [
|
||||||
|
{
|
||||||
|
"type": "null"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "boolean"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "number"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "array"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "object"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"description": "User-defined metadata (deprecated, use attributes)"
|
||||||
|
},
|
||||||
|
"owner": {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"principal": {
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
"attributes": {
|
||||||
|
"type": "object",
|
||||||
|
"additionalProperties": {
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"additionalProperties": false,
|
||||||
|
"required": [
|
||||||
|
"principal"
|
||||||
|
],
|
||||||
|
"description": "User who created this provider connection"
|
||||||
|
},
|
||||||
|
"attributes": {
|
||||||
|
"type": "object",
|
||||||
|
"additionalProperties": {
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"description": "Key-value attributes for ABAC access control"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"additionalProperties": false,
|
||||||
|
"required": [
|
||||||
|
"provider_id",
|
||||||
|
"api",
|
||||||
|
"provider_type",
|
||||||
|
"config",
|
||||||
|
"status",
|
||||||
|
"created_at",
|
||||||
|
"updated_at",
|
||||||
|
"metadata"
|
||||||
|
],
|
||||||
|
"title": "ProviderConnectionInfo",
|
||||||
|
"description": "Information about a dynamically managed provider connection.\nThis model represents a provider that has been registered at runtime\nvia the /providers API, as opposed to static providers configured in run.yaml.\n\nDynamic providers support full lifecycle management including registration,\nconfiguration updates, health monitoring, and removal."
|
||||||
|
},
|
||||||
|
"ProviderConnectionStatus": {
|
||||||
|
"type": "string",
|
||||||
|
"enum": [
|
||||||
|
"pending",
|
||||||
|
"initializing",
|
||||||
|
"connected",
|
||||||
|
"failed",
|
||||||
|
"disconnected",
|
||||||
|
"testing"
|
||||||
|
],
|
||||||
|
"title": "ProviderConnectionStatus",
|
||||||
|
"description": "Status of a dynamic provider connection."
|
||||||
|
},
|
||||||
|
"ProviderHealth": {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"status": {
|
||||||
|
"type": "string",
|
||||||
|
"enum": [
|
||||||
|
"OK",
|
||||||
|
"Error",
|
||||||
|
"Not Implemented"
|
||||||
|
],
|
||||||
|
"description": "Health status (OK, ERROR, NOT_IMPLEMENTED)"
|
||||||
|
},
|
||||||
|
"message": {
|
||||||
|
"type": "string",
|
||||||
|
"description": "Optional error or status message"
|
||||||
|
},
|
||||||
|
"metrics": {
|
||||||
|
"type": "object",
|
||||||
|
"additionalProperties": {
|
||||||
|
"oneOf": [
|
||||||
|
{
|
||||||
|
"type": "null"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "boolean"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "number"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "array"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "object"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"description": "Provider-specific health metrics"
|
||||||
|
},
|
||||||
|
"last_checked": {
|
||||||
|
"type": "string",
|
||||||
|
"format": "date-time",
|
||||||
|
"description": "Timestamp of last health check"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"additionalProperties": false,
|
||||||
|
"required": [
|
||||||
|
"status",
|
||||||
|
"metrics",
|
||||||
|
"last_checked"
|
||||||
|
],
|
||||||
|
"title": "ProviderHealth",
|
||||||
|
"description": "Structured wrapper around provider health status.\nThis wraps the existing dict-based HealthResponse for API responses\nwhile maintaining backward compatibility with existing provider implementations."
|
||||||
|
},
|
||||||
|
"RegisterProviderResponse": {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"provider": {
|
||||||
|
"$ref": "#/components/schemas/ProviderConnectionInfo",
|
||||||
|
"description": "Information about the registered provider"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"additionalProperties": false,
|
||||||
|
"required": [
|
||||||
|
"provider"
|
||||||
|
],
|
||||||
|
"title": "RegisterProviderResponse",
|
||||||
|
"description": "Response after registering a provider."
|
||||||
|
},
|
||||||
|
"UpdateProviderRequest": {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"config": {
|
||||||
|
"type": "object",
|
||||||
|
"additionalProperties": {
|
||||||
|
"oneOf": [
|
||||||
|
{
|
||||||
|
"type": "null"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "boolean"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "number"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "array"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "object"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"description": "New configuration parameters (merged with existing)"
|
||||||
|
},
|
||||||
|
"attributes": {
|
||||||
|
"type": "object",
|
||||||
|
"additionalProperties": {
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"description": "New attributes for access control"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"additionalProperties": false,
|
||||||
|
"title": "UpdateProviderRequest"
|
||||||
|
},
|
||||||
|
"UpdateProviderResponse": {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"provider": {
|
||||||
|
"$ref": "#/components/schemas/ProviderConnectionInfo",
|
||||||
|
"description": "Updated provider information"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"additionalProperties": false,
|
||||||
|
"required": [
|
||||||
|
"provider"
|
||||||
|
],
|
||||||
|
"title": "UpdateProviderResponse",
|
||||||
|
"description": "Response after updating a provider."
|
||||||
|
},
|
||||||
|
"TestProviderConnectionResponse": {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"success": {
|
||||||
|
"type": "boolean",
|
||||||
|
"description": "Whether the connection test succeeded"
|
||||||
|
},
|
||||||
|
"health": {
|
||||||
|
"type": "object",
|
||||||
|
"additionalProperties": {
|
||||||
|
"oneOf": [
|
||||||
|
{
|
||||||
|
"type": "null"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "boolean"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "number"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "array"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "object"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"description": "Health status from the provider"
|
||||||
|
},
|
||||||
|
"error_message": {
|
||||||
|
"type": "string",
|
||||||
|
"description": "Error message if test failed"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"additionalProperties": false,
|
||||||
|
"required": [
|
||||||
|
"success"
|
||||||
|
],
|
||||||
|
"title": "TestProviderConnectionResponse",
|
||||||
|
"description": "Response from testing a provider connection."
|
||||||
|
},
|
||||||
"AgentConfig": {
|
"AgentConfig": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
|
|
@ -5520,9 +6123,19 @@
|
||||||
"description": "Llama Stack Evaluation API for running evaluations on model and agent candidates.",
|
"description": "Llama Stack Evaluation API for running evaluations on model and agent candidates.",
|
||||||
"x-displayName": "Evaluations"
|
"x-displayName": "Evaluations"
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
"name": "Inspect",
|
||||||
|
"description": "APIs for inspecting the Llama Stack service, including health status, available API routes with methods and implementing providers.",
|
||||||
|
"x-displayName": "Inspect"
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"name": "PostTraining (Coming Soon)",
|
"name": "PostTraining (Coming Soon)",
|
||||||
"description": ""
|
"description": ""
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "Providers",
|
||||||
|
"description": "Providers API for inspecting, listing, and modifying providers and their configurations.",
|
||||||
|
"x-displayName": "Providers"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"x-tagGroups": [
|
"x-tagGroups": [
|
||||||
|
|
@ -5534,7 +6147,9 @@
|
||||||
"DatasetIO",
|
"DatasetIO",
|
||||||
"Datasets",
|
"Datasets",
|
||||||
"Eval",
|
"Eval",
|
||||||
"PostTraining (Coming Soon)"
|
"Inspect",
|
||||||
|
"PostTraining (Coming Soon)",
|
||||||
|
"Providers"
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
|
|
|
||||||
450
docs/static/experimental-llama-stack-spec.yaml
vendored
450
docs/static/experimental-llama-stack-spec.yaml
vendored
|
|
@ -220,6 +220,178 @@ paths:
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
deprecated: false
|
deprecated: false
|
||||||
|
/v1alpha/admin/providers/{api}:
|
||||||
|
post:
|
||||||
|
responses:
|
||||||
|
'200':
|
||||||
|
description: >-
|
||||||
|
RegisterProviderResponse with the registered provider info.
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: '#/components/schemas/RegisterProviderResponse'
|
||||||
|
'400':
|
||||||
|
$ref: '#/components/responses/BadRequest400'
|
||||||
|
'429':
|
||||||
|
$ref: >-
|
||||||
|
#/components/responses/TooManyRequests429
|
||||||
|
'500':
|
||||||
|
$ref: >-
|
||||||
|
#/components/responses/InternalServerError500
|
||||||
|
default:
|
||||||
|
$ref: '#/components/responses/DefaultError'
|
||||||
|
tags:
|
||||||
|
- Providers
|
||||||
|
summary: Register a new dynamic provider.
|
||||||
|
description: >-
|
||||||
|
Register a new dynamic provider.
|
||||||
|
|
||||||
|
Register a new provider instance at runtime. The provider will be validated,
|
||||||
|
|
||||||
|
instantiated, and persisted to the kvstore. Requires appropriate ABAC permissions.
|
||||||
|
parameters:
|
||||||
|
- name: api
|
||||||
|
in: path
|
||||||
|
description: >-
|
||||||
|
API namespace this provider implements (e.g., 'inference', 'vector_io').
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
requestBody:
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: '#/components/schemas/RegisterProviderRequest'
|
||||||
|
required: true
|
||||||
|
deprecated: false
|
||||||
|
/v1alpha/admin/providers/{api}/{provider_id}:
|
||||||
|
post:
|
||||||
|
responses:
|
||||||
|
'200':
|
||||||
|
description: >-
|
||||||
|
UpdateProviderResponse with updated provider info
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: '#/components/schemas/UpdateProviderResponse'
|
||||||
|
'400':
|
||||||
|
$ref: '#/components/responses/BadRequest400'
|
||||||
|
'429':
|
||||||
|
$ref: >-
|
||||||
|
#/components/responses/TooManyRequests429
|
||||||
|
'500':
|
||||||
|
$ref: >-
|
||||||
|
#/components/responses/InternalServerError500
|
||||||
|
default:
|
||||||
|
$ref: '#/components/responses/DefaultError'
|
||||||
|
tags:
|
||||||
|
- Providers
|
||||||
|
summary: >-
|
||||||
|
Update an existing provider's configuration.
|
||||||
|
description: >-
|
||||||
|
Update an existing provider's configuration.
|
||||||
|
|
||||||
|
Update the configuration and/or attributes of a dynamic provider. The provider
|
||||||
|
|
||||||
|
will be re-instantiated with the new configuration (hot-reload).
|
||||||
|
parameters:
|
||||||
|
- name: api
|
||||||
|
in: path
|
||||||
|
description: API namespace the provider implements
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
- name: provider_id
|
||||||
|
in: path
|
||||||
|
description: ID of the provider to update
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
requestBody:
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: '#/components/schemas/UpdateProviderRequest'
|
||||||
|
required: true
|
||||||
|
deprecated: false
|
||||||
|
delete:
|
||||||
|
responses:
|
||||||
|
'200':
|
||||||
|
description: OK
|
||||||
|
'400':
|
||||||
|
$ref: '#/components/responses/BadRequest400'
|
||||||
|
'429':
|
||||||
|
$ref: >-
|
||||||
|
#/components/responses/TooManyRequests429
|
||||||
|
'500':
|
||||||
|
$ref: >-
|
||||||
|
#/components/responses/InternalServerError500
|
||||||
|
default:
|
||||||
|
$ref: '#/components/responses/DefaultError'
|
||||||
|
tags:
|
||||||
|
- Providers
|
||||||
|
summary: Unregister a dynamic provider.
|
||||||
|
description: >-
|
||||||
|
Unregister a dynamic provider.
|
||||||
|
|
||||||
|
Remove a dynamic provider, shutting down its instance and removing it from
|
||||||
|
|
||||||
|
the kvstore.
|
||||||
|
parameters:
|
||||||
|
- name: api
|
||||||
|
in: path
|
||||||
|
description: API namespace the provider implements
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
- name: provider_id
|
||||||
|
in: path
|
||||||
|
description: ID of the provider to unregister.
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
deprecated: false
|
||||||
|
/v1alpha/admin/providers/{api}/{provider_id}/health:
|
||||||
|
get:
|
||||||
|
responses:
|
||||||
|
'200':
|
||||||
|
description: >-
|
||||||
|
TestProviderConnectionResponse with health status.
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: '#/components/schemas/TestProviderConnectionResponse'
|
||||||
|
'400':
|
||||||
|
$ref: '#/components/responses/BadRequest400'
|
||||||
|
'429':
|
||||||
|
$ref: >-
|
||||||
|
#/components/responses/TooManyRequests429
|
||||||
|
'500':
|
||||||
|
$ref: >-
|
||||||
|
#/components/responses/InternalServerError500
|
||||||
|
default:
|
||||||
|
$ref: '#/components/responses/DefaultError'
|
||||||
|
tags:
|
||||||
|
- Inspect
|
||||||
|
summary: Check provider health.
|
||||||
|
description: >-
|
||||||
|
Check provider health.
|
||||||
|
|
||||||
|
Execute a health check on a provider to verify it is reachable and functioning.
|
||||||
|
parameters:
|
||||||
|
- name: api
|
||||||
|
in: path
|
||||||
|
description: API namespace the provider implements.
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
- name: provider_id
|
||||||
|
in: path
|
||||||
|
description: ID of the provider to check.
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
deprecated: false
|
||||||
/v1alpha/agents:
|
/v1alpha/agents:
|
||||||
get:
|
get:
|
||||||
responses:
|
responses:
|
||||||
|
|
@ -1495,6 +1667,273 @@ components:
|
||||||
- purpose
|
- purpose
|
||||||
- source
|
- source
|
||||||
title: RegisterDatasetRequest
|
title: RegisterDatasetRequest
|
||||||
|
RegisterProviderRequest:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
provider_id:
|
||||||
|
type: string
|
||||||
|
description: >-
|
||||||
|
Unique identifier for this provider instance.
|
||||||
|
provider_type:
|
||||||
|
type: string
|
||||||
|
description: Provider type (e.g., 'remote::openai').
|
||||||
|
config:
|
||||||
|
type: object
|
||||||
|
additionalProperties:
|
||||||
|
oneOf:
|
||||||
|
- type: 'null'
|
||||||
|
- type: boolean
|
||||||
|
- type: number
|
||||||
|
- type: string
|
||||||
|
- type: array
|
||||||
|
- type: object
|
||||||
|
description: >-
|
||||||
|
Provider configuration (API keys, endpoints, etc.).
|
||||||
|
attributes:
|
||||||
|
type: object
|
||||||
|
additionalProperties:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
description: >-
|
||||||
|
Optional attributes for ABAC access control.
|
||||||
|
additionalProperties: false
|
||||||
|
required:
|
||||||
|
- provider_id
|
||||||
|
- provider_type
|
||||||
|
- config
|
||||||
|
title: RegisterProviderRequest
|
||||||
|
ProviderConnectionInfo:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
provider_id:
|
||||||
|
type: string
|
||||||
|
description: >-
|
||||||
|
Unique identifier for this provider instance
|
||||||
|
api:
|
||||||
|
type: string
|
||||||
|
description: >-
|
||||||
|
API namespace (e.g., "inference", "vector_io", "safety")
|
||||||
|
provider_type:
|
||||||
|
type: string
|
||||||
|
description: >-
|
||||||
|
Provider type identifier (e.g., "remote::openai", "inline::faiss")
|
||||||
|
config:
|
||||||
|
type: object
|
||||||
|
additionalProperties:
|
||||||
|
oneOf:
|
||||||
|
- type: 'null'
|
||||||
|
- type: boolean
|
||||||
|
- type: number
|
||||||
|
- type: string
|
||||||
|
- type: array
|
||||||
|
- type: object
|
||||||
|
description: >-
|
||||||
|
Provider-specific configuration (API keys, endpoints, etc.)
|
||||||
|
status:
|
||||||
|
$ref: '#/components/schemas/ProviderConnectionStatus'
|
||||||
|
description: Current connection status
|
||||||
|
health:
|
||||||
|
$ref: '#/components/schemas/ProviderHealth'
|
||||||
|
description: Most recent health check result
|
||||||
|
created_at:
|
||||||
|
type: string
|
||||||
|
format: date-time
|
||||||
|
description: Timestamp when provider was registered
|
||||||
|
updated_at:
|
||||||
|
type: string
|
||||||
|
format: date-time
|
||||||
|
description: Timestamp of last update
|
||||||
|
last_health_check:
|
||||||
|
type: string
|
||||||
|
format: date-time
|
||||||
|
description: Timestamp of last health check
|
||||||
|
error_message:
|
||||||
|
type: string
|
||||||
|
description: Error message if status is failed
|
||||||
|
metadata:
|
||||||
|
type: object
|
||||||
|
additionalProperties:
|
||||||
|
oneOf:
|
||||||
|
- type: 'null'
|
||||||
|
- type: boolean
|
||||||
|
- type: number
|
||||||
|
- type: string
|
||||||
|
- type: array
|
||||||
|
- type: object
|
||||||
|
description: >-
|
||||||
|
User-defined metadata (deprecated, use attributes)
|
||||||
|
owner:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
principal:
|
||||||
|
type: string
|
||||||
|
attributes:
|
||||||
|
type: object
|
||||||
|
additionalProperties:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
additionalProperties: false
|
||||||
|
required:
|
||||||
|
- principal
|
||||||
|
description: >-
|
||||||
|
User who created this provider connection
|
||||||
|
attributes:
|
||||||
|
type: object
|
||||||
|
additionalProperties:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
description: >-
|
||||||
|
Key-value attributes for ABAC access control
|
||||||
|
additionalProperties: false
|
||||||
|
required:
|
||||||
|
- provider_id
|
||||||
|
- api
|
||||||
|
- provider_type
|
||||||
|
- config
|
||||||
|
- status
|
||||||
|
- created_at
|
||||||
|
- updated_at
|
||||||
|
- metadata
|
||||||
|
title: ProviderConnectionInfo
|
||||||
|
description: >-
|
||||||
|
Information about a dynamically managed provider connection.
|
||||||
|
|
||||||
|
This model represents a provider that has been registered at runtime
|
||||||
|
|
||||||
|
via the /providers API, as opposed to static providers configured in run.yaml.
|
||||||
|
|
||||||
|
|
||||||
|
Dynamic providers support full lifecycle management including registration,
|
||||||
|
|
||||||
|
configuration updates, health monitoring, and removal.
|
||||||
|
ProviderConnectionStatus:
|
||||||
|
type: string
|
||||||
|
enum:
|
||||||
|
- pending
|
||||||
|
- initializing
|
||||||
|
- connected
|
||||||
|
- failed
|
||||||
|
- disconnected
|
||||||
|
- testing
|
||||||
|
title: ProviderConnectionStatus
|
||||||
|
description: Status of a dynamic provider connection.
|
||||||
|
ProviderHealth:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
status:
|
||||||
|
type: string
|
||||||
|
enum:
|
||||||
|
- OK
|
||||||
|
- Error
|
||||||
|
- Not Implemented
|
||||||
|
description: >-
|
||||||
|
Health status (OK, ERROR, NOT_IMPLEMENTED)
|
||||||
|
message:
|
||||||
|
type: string
|
||||||
|
description: Optional error or status message
|
||||||
|
metrics:
|
||||||
|
type: object
|
||||||
|
additionalProperties:
|
||||||
|
oneOf:
|
||||||
|
- type: 'null'
|
||||||
|
- type: boolean
|
||||||
|
- type: number
|
||||||
|
- type: string
|
||||||
|
- type: array
|
||||||
|
- type: object
|
||||||
|
description: Provider-specific health metrics
|
||||||
|
last_checked:
|
||||||
|
type: string
|
||||||
|
format: date-time
|
||||||
|
description: Timestamp of last health check
|
||||||
|
additionalProperties: false
|
||||||
|
required:
|
||||||
|
- status
|
||||||
|
- metrics
|
||||||
|
- last_checked
|
||||||
|
title: ProviderHealth
|
||||||
|
description: >-
|
||||||
|
Structured wrapper around provider health status.
|
||||||
|
|
||||||
|
This wraps the existing dict-based HealthResponse for API responses
|
||||||
|
|
||||||
|
while maintaining backward compatibility with existing provider implementations.
|
||||||
|
RegisterProviderResponse:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
provider:
|
||||||
|
$ref: '#/components/schemas/ProviderConnectionInfo'
|
||||||
|
description: >-
|
||||||
|
Information about the registered provider
|
||||||
|
additionalProperties: false
|
||||||
|
required:
|
||||||
|
- provider
|
||||||
|
title: RegisterProviderResponse
|
||||||
|
description: Response after registering a provider.
|
||||||
|
UpdateProviderRequest:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
config:
|
||||||
|
type: object
|
||||||
|
additionalProperties:
|
||||||
|
oneOf:
|
||||||
|
- type: 'null'
|
||||||
|
- type: boolean
|
||||||
|
- type: number
|
||||||
|
- type: string
|
||||||
|
- type: array
|
||||||
|
- type: object
|
||||||
|
description: >-
|
||||||
|
New configuration parameters (merged with existing)
|
||||||
|
attributes:
|
||||||
|
type: object
|
||||||
|
additionalProperties:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
description: New attributes for access control
|
||||||
|
additionalProperties: false
|
||||||
|
title: UpdateProviderRequest
|
||||||
|
UpdateProviderResponse:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
provider:
|
||||||
|
$ref: '#/components/schemas/ProviderConnectionInfo'
|
||||||
|
description: Updated provider information
|
||||||
|
additionalProperties: false
|
||||||
|
required:
|
||||||
|
- provider
|
||||||
|
title: UpdateProviderResponse
|
||||||
|
description: Response after updating a provider.
|
||||||
|
TestProviderConnectionResponse:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
success:
|
||||||
|
type: boolean
|
||||||
|
description: Whether the connection test succeeded
|
||||||
|
health:
|
||||||
|
type: object
|
||||||
|
additionalProperties:
|
||||||
|
oneOf:
|
||||||
|
- type: 'null'
|
||||||
|
- type: boolean
|
||||||
|
- type: number
|
||||||
|
- type: string
|
||||||
|
- type: array
|
||||||
|
- type: object
|
||||||
|
description: Health status from the provider
|
||||||
|
error_message:
|
||||||
|
type: string
|
||||||
|
description: Error message if test failed
|
||||||
|
additionalProperties: false
|
||||||
|
required:
|
||||||
|
- success
|
||||||
|
title: TestProviderConnectionResponse
|
||||||
|
description: >-
|
||||||
|
Response from testing a provider connection.
|
||||||
AgentConfig:
|
AgentConfig:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
|
|
@ -4121,8 +4560,17 @@ tags:
|
||||||
description: >-
|
description: >-
|
||||||
Llama Stack Evaluation API for running evaluations on model and agent candidates.
|
Llama Stack Evaluation API for running evaluations on model and agent candidates.
|
||||||
x-displayName: Evaluations
|
x-displayName: Evaluations
|
||||||
|
- name: Inspect
|
||||||
|
description: >-
|
||||||
|
APIs for inspecting the Llama Stack service, including health status, available
|
||||||
|
API routes with methods and implementing providers.
|
||||||
|
x-displayName: Inspect
|
||||||
- name: PostTraining (Coming Soon)
|
- name: PostTraining (Coming Soon)
|
||||||
description: ''
|
description: ''
|
||||||
|
- name: Providers
|
||||||
|
description: >-
|
||||||
|
Providers API for inspecting, listing, and modifying providers and their configurations.
|
||||||
|
x-displayName: Providers
|
||||||
x-tagGroups:
|
x-tagGroups:
|
||||||
- name: Operations
|
- name: Operations
|
||||||
tags:
|
tags:
|
||||||
|
|
@ -4131,4 +4579,6 @@ x-tagGroups:
|
||||||
- DatasetIO
|
- DatasetIO
|
||||||
- Datasets
|
- Datasets
|
||||||
- Eval
|
- Eval
|
||||||
|
- Inspect
|
||||||
- PostTraining (Coming Soon)
|
- PostTraining (Coming Soon)
|
||||||
|
- Providers
|
||||||
|
|
|
||||||
658
docs/static/llama-stack-spec.html
vendored
658
docs/static/llama-stack-spec.html
vendored
|
|
@ -40,224 +40,6 @@
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"paths": {
|
"paths": {
|
||||||
"/v1/admin/providers/{api}": {
|
|
||||||
"post": {
|
|
||||||
"responses": {
|
|
||||||
"200": {
|
|
||||||
"description": "RegisterProviderResponse with the registered provider info.",
|
|
||||||
"content": {
|
|
||||||
"application/json": {
|
|
||||||
"schema": {
|
|
||||||
"$ref": "#/components/schemas/RegisterProviderResponse"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"400": {
|
|
||||||
"$ref": "#/components/responses/BadRequest400"
|
|
||||||
},
|
|
||||||
"429": {
|
|
||||||
"$ref": "#/components/responses/TooManyRequests429"
|
|
||||||
},
|
|
||||||
"500": {
|
|
||||||
"$ref": "#/components/responses/InternalServerError500"
|
|
||||||
},
|
|
||||||
"default": {
|
|
||||||
"$ref": "#/components/responses/DefaultError"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"tags": [
|
|
||||||
"Providers"
|
|
||||||
],
|
|
||||||
"summary": "Register a new dynamic provider.",
|
|
||||||
"description": "Register a new dynamic provider.\nRegister a new provider instance at runtime. The provider will be validated,\ninstantiated, and persisted to the kvstore. Requires appropriate ABAC permissions.",
|
|
||||||
"parameters": [
|
|
||||||
{
|
|
||||||
"name": "api",
|
|
||||||
"in": "path",
|
|
||||||
"description": "API namespace this provider implements (e.g., 'inference', 'vector_io').",
|
|
||||||
"required": true,
|
|
||||||
"schema": {
|
|
||||||
"type": "string"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"requestBody": {
|
|
||||||
"content": {
|
|
||||||
"application/json": {
|
|
||||||
"schema": {
|
|
||||||
"$ref": "#/components/schemas/RegisterProviderRequest"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"required": true
|
|
||||||
},
|
|
||||||
"deprecated": false
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"/v1/admin/providers/{api}/{provider_id}": {
|
|
||||||
"post": {
|
|
||||||
"responses": {
|
|
||||||
"200": {
|
|
||||||
"description": "UpdateProviderResponse with updated provider info",
|
|
||||||
"content": {
|
|
||||||
"application/json": {
|
|
||||||
"schema": {
|
|
||||||
"$ref": "#/components/schemas/UpdateProviderResponse"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"400": {
|
|
||||||
"$ref": "#/components/responses/BadRequest400"
|
|
||||||
},
|
|
||||||
"429": {
|
|
||||||
"$ref": "#/components/responses/TooManyRequests429"
|
|
||||||
},
|
|
||||||
"500": {
|
|
||||||
"$ref": "#/components/responses/InternalServerError500"
|
|
||||||
},
|
|
||||||
"default": {
|
|
||||||
"$ref": "#/components/responses/DefaultError"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"tags": [
|
|
||||||
"Providers"
|
|
||||||
],
|
|
||||||
"summary": "Update an existing provider's configuration.",
|
|
||||||
"description": "Update an existing provider's configuration.\nUpdate the configuration and/or attributes of a dynamic provider. The provider\nwill be re-instantiated with the new configuration (hot-reload).",
|
|
||||||
"parameters": [
|
|
||||||
{
|
|
||||||
"name": "api",
|
|
||||||
"in": "path",
|
|
||||||
"description": "API namespace the provider implements",
|
|
||||||
"required": true,
|
|
||||||
"schema": {
|
|
||||||
"type": "string"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"name": "provider_id",
|
|
||||||
"in": "path",
|
|
||||||
"description": "ID of the provider to update",
|
|
||||||
"required": true,
|
|
||||||
"schema": {
|
|
||||||
"type": "string"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"requestBody": {
|
|
||||||
"content": {
|
|
||||||
"application/json": {
|
|
||||||
"schema": {
|
|
||||||
"$ref": "#/components/schemas/UpdateProviderRequest"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"required": true
|
|
||||||
},
|
|
||||||
"deprecated": false
|
|
||||||
},
|
|
||||||
"delete": {
|
|
||||||
"responses": {
|
|
||||||
"200": {
|
|
||||||
"description": "OK"
|
|
||||||
},
|
|
||||||
"400": {
|
|
||||||
"$ref": "#/components/responses/BadRequest400"
|
|
||||||
},
|
|
||||||
"429": {
|
|
||||||
"$ref": "#/components/responses/TooManyRequests429"
|
|
||||||
},
|
|
||||||
"500": {
|
|
||||||
"$ref": "#/components/responses/InternalServerError500"
|
|
||||||
},
|
|
||||||
"default": {
|
|
||||||
"$ref": "#/components/responses/DefaultError"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"tags": [
|
|
||||||
"Providers"
|
|
||||||
],
|
|
||||||
"summary": "Unregister a dynamic provider.",
|
|
||||||
"description": "Unregister a dynamic provider.\nRemove a dynamic provider, shutting down its instance and removing it from\nthe kvstore.",
|
|
||||||
"parameters": [
|
|
||||||
{
|
|
||||||
"name": "api",
|
|
||||||
"in": "path",
|
|
||||||
"description": "API namespace the provider implements",
|
|
||||||
"required": true,
|
|
||||||
"schema": {
|
|
||||||
"type": "string"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"name": "provider_id",
|
|
||||||
"in": "path",
|
|
||||||
"description": "ID of the provider to unregister.",
|
|
||||||
"required": true,
|
|
||||||
"schema": {
|
|
||||||
"type": "string"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"deprecated": false
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"/v1/admin/providers/{api}/{provider_id}/test": {
|
|
||||||
"post": {
|
|
||||||
"responses": {
|
|
||||||
"200": {
|
|
||||||
"description": "TestProviderConnectionResponse with health status.",
|
|
||||||
"content": {
|
|
||||||
"application/json": {
|
|
||||||
"schema": {
|
|
||||||
"$ref": "#/components/schemas/TestProviderConnectionResponse"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"400": {
|
|
||||||
"$ref": "#/components/responses/BadRequest400"
|
|
||||||
},
|
|
||||||
"429": {
|
|
||||||
"$ref": "#/components/responses/TooManyRequests429"
|
|
||||||
},
|
|
||||||
"500": {
|
|
||||||
"$ref": "#/components/responses/InternalServerError500"
|
|
||||||
},
|
|
||||||
"default": {
|
|
||||||
"$ref": "#/components/responses/DefaultError"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"tags": [
|
|
||||||
"Providers"
|
|
||||||
],
|
|
||||||
"summary": "Test a provider connection.",
|
|
||||||
"description": "Test a provider connection.\nExecute a health check on a provider to verify it is reachable and functioning.",
|
|
||||||
"parameters": [
|
|
||||||
{
|
|
||||||
"name": "api",
|
|
||||||
"in": "path",
|
|
||||||
"description": "API namespace the provider implements.",
|
|
||||||
"required": true,
|
|
||||||
"schema": {
|
|
||||||
"type": "string"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"name": "provider_id",
|
|
||||||
"in": "path",
|
|
||||||
"description": "ID of the provider to test.",
|
|
||||||
"required": true,
|
|
||||||
"schema": {
|
|
||||||
"type": "string"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"deprecated": false
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"/v1/chat/completions": {
|
"/v1/chat/completions": {
|
||||||
"get": {
|
"get": {
|
||||||
"responses": {
|
"responses": {
|
||||||
|
|
@ -1223,41 +1005,6 @@
|
||||||
"deprecated": false
|
"deprecated": false
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"/v1/health": {
|
|
||||||
"get": {
|
|
||||||
"responses": {
|
|
||||||
"200": {
|
|
||||||
"description": "Health information indicating if the service is operational.",
|
|
||||||
"content": {
|
|
||||||
"application/json": {
|
|
||||||
"schema": {
|
|
||||||
"$ref": "#/components/schemas/HealthInfo"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"400": {
|
|
||||||
"$ref": "#/components/responses/BadRequest400"
|
|
||||||
},
|
|
||||||
"429": {
|
|
||||||
"$ref": "#/components/responses/TooManyRequests429"
|
|
||||||
},
|
|
||||||
"500": {
|
|
||||||
"$ref": "#/components/responses/InternalServerError500"
|
|
||||||
},
|
|
||||||
"default": {
|
|
||||||
"$ref": "#/components/responses/DefaultError"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"tags": [
|
|
||||||
"Inspect"
|
|
||||||
],
|
|
||||||
"summary": "Get health status.",
|
|
||||||
"description": "Get health status.\nGet the current health status of the service.",
|
|
||||||
"parameters": [],
|
|
||||||
"deprecated": false
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"/v1/inspect/routes": {
|
"/v1/inspect/routes": {
|
||||||
"get": {
|
"get": {
|
||||||
"responses": {
|
"responses": {
|
||||||
|
|
@ -4277,391 +4024,6 @@
|
||||||
"title": "Error",
|
"title": "Error",
|
||||||
"description": "Error response from the API. Roughly follows RFC 7807."
|
"description": "Error response from the API. Roughly follows RFC 7807."
|
||||||
},
|
},
|
||||||
"RegisterProviderRequest": {
|
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"provider_id": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "Unique identifier for this provider instance."
|
|
||||||
},
|
|
||||||
"provider_type": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "Provider type (e.g., 'remote::openai')."
|
|
||||||
},
|
|
||||||
"config": {
|
|
||||||
"type": "object",
|
|
||||||
"additionalProperties": {
|
|
||||||
"oneOf": [
|
|
||||||
{
|
|
||||||
"type": "null"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "boolean"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "number"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "array"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "object"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"description": "Provider configuration (API keys, endpoints, etc.)."
|
|
||||||
},
|
|
||||||
"attributes": {
|
|
||||||
"type": "object",
|
|
||||||
"additionalProperties": {
|
|
||||||
"type": "array",
|
|
||||||
"items": {
|
|
||||||
"type": "string"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"description": "Optional attributes for ABAC access control."
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"additionalProperties": false,
|
|
||||||
"required": [
|
|
||||||
"provider_id",
|
|
||||||
"provider_type",
|
|
||||||
"config"
|
|
||||||
],
|
|
||||||
"title": "RegisterProviderRequest"
|
|
||||||
},
|
|
||||||
"ProviderConnectionInfo": {
|
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"provider_id": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "Unique identifier for this provider instance"
|
|
||||||
},
|
|
||||||
"api": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "API namespace (e.g., \"inference\", \"vector_io\", \"safety\")"
|
|
||||||
},
|
|
||||||
"provider_type": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "Provider type identifier (e.g., \"remote::openai\", \"inline::faiss\")"
|
|
||||||
},
|
|
||||||
"config": {
|
|
||||||
"type": "object",
|
|
||||||
"additionalProperties": {
|
|
||||||
"oneOf": [
|
|
||||||
{
|
|
||||||
"type": "null"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "boolean"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "number"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "array"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "object"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"description": "Provider-specific configuration (API keys, endpoints, etc.)"
|
|
||||||
},
|
|
||||||
"status": {
|
|
||||||
"$ref": "#/components/schemas/ProviderConnectionStatus",
|
|
||||||
"description": "Current connection status"
|
|
||||||
},
|
|
||||||
"health": {
|
|
||||||
"$ref": "#/components/schemas/ProviderHealth",
|
|
||||||
"description": "Most recent health check result"
|
|
||||||
},
|
|
||||||
"created_at": {
|
|
||||||
"type": "string",
|
|
||||||
"format": "date-time",
|
|
||||||
"description": "Timestamp when provider was registered"
|
|
||||||
},
|
|
||||||
"updated_at": {
|
|
||||||
"type": "string",
|
|
||||||
"format": "date-time",
|
|
||||||
"description": "Timestamp of last update"
|
|
||||||
},
|
|
||||||
"last_health_check": {
|
|
||||||
"type": "string",
|
|
||||||
"format": "date-time",
|
|
||||||
"description": "Timestamp of last health check"
|
|
||||||
},
|
|
||||||
"error_message": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "Error message if status is failed"
|
|
||||||
},
|
|
||||||
"metadata": {
|
|
||||||
"type": "object",
|
|
||||||
"additionalProperties": {
|
|
||||||
"oneOf": [
|
|
||||||
{
|
|
||||||
"type": "null"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "boolean"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "number"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "array"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "object"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"description": "User-defined metadata (deprecated, use attributes)"
|
|
||||||
},
|
|
||||||
"owner": {
|
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"principal": {
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"attributes": {
|
|
||||||
"type": "object",
|
|
||||||
"additionalProperties": {
|
|
||||||
"type": "array",
|
|
||||||
"items": {
|
|
||||||
"type": "string"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"additionalProperties": false,
|
|
||||||
"required": [
|
|
||||||
"principal"
|
|
||||||
],
|
|
||||||
"description": "User who created this provider connection"
|
|
||||||
},
|
|
||||||
"attributes": {
|
|
||||||
"type": "object",
|
|
||||||
"additionalProperties": {
|
|
||||||
"type": "array",
|
|
||||||
"items": {
|
|
||||||
"type": "string"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"description": "Key-value attributes for ABAC access control"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"additionalProperties": false,
|
|
||||||
"required": [
|
|
||||||
"provider_id",
|
|
||||||
"api",
|
|
||||||
"provider_type",
|
|
||||||
"config",
|
|
||||||
"status",
|
|
||||||
"created_at",
|
|
||||||
"updated_at",
|
|
||||||
"metadata"
|
|
||||||
],
|
|
||||||
"title": "ProviderConnectionInfo",
|
|
||||||
"description": "Information about a dynamically managed provider connection.\nThis model represents a provider that has been registered at runtime\nvia the /providers API, as opposed to static providers configured in run.yaml.\n\nDynamic providers support full lifecycle management including registration,\nconfiguration updates, health monitoring, and removal."
|
|
||||||
},
|
|
||||||
"ProviderConnectionStatus": {
|
|
||||||
"type": "string",
|
|
||||||
"enum": [
|
|
||||||
"pending",
|
|
||||||
"initializing",
|
|
||||||
"connected",
|
|
||||||
"failed",
|
|
||||||
"disconnected",
|
|
||||||
"testing"
|
|
||||||
],
|
|
||||||
"title": "ProviderConnectionStatus",
|
|
||||||
"description": "Status of a dynamic provider connection."
|
|
||||||
},
|
|
||||||
"ProviderHealth": {
|
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"status": {
|
|
||||||
"type": "string",
|
|
||||||
"enum": [
|
|
||||||
"OK",
|
|
||||||
"Error",
|
|
||||||
"Not Implemented"
|
|
||||||
],
|
|
||||||
"description": "Health status (OK, ERROR, NOT_IMPLEMENTED)"
|
|
||||||
},
|
|
||||||
"message": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "Optional error or status message"
|
|
||||||
},
|
|
||||||
"metrics": {
|
|
||||||
"type": "object",
|
|
||||||
"additionalProperties": {
|
|
||||||
"oneOf": [
|
|
||||||
{
|
|
||||||
"type": "null"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "boolean"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "number"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "array"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "object"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"description": "Provider-specific health metrics"
|
|
||||||
},
|
|
||||||
"last_checked": {
|
|
||||||
"type": "string",
|
|
||||||
"format": "date-time",
|
|
||||||
"description": "Timestamp of last health check"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"additionalProperties": false,
|
|
||||||
"required": [
|
|
||||||
"status",
|
|
||||||
"metrics",
|
|
||||||
"last_checked"
|
|
||||||
],
|
|
||||||
"title": "ProviderHealth",
|
|
||||||
"description": "Structured wrapper around provider health status.\nThis wraps the existing dict-based HealthResponse for API responses\nwhile maintaining backward compatibility with existing provider implementations."
|
|
||||||
},
|
|
||||||
"RegisterProviderResponse": {
|
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"provider": {
|
|
||||||
"$ref": "#/components/schemas/ProviderConnectionInfo",
|
|
||||||
"description": "Information about the registered provider"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"additionalProperties": false,
|
|
||||||
"required": [
|
|
||||||
"provider"
|
|
||||||
],
|
|
||||||
"title": "RegisterProviderResponse",
|
|
||||||
"description": "Response after registering a provider."
|
|
||||||
},
|
|
||||||
"UpdateProviderRequest": {
|
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"config": {
|
|
||||||
"type": "object",
|
|
||||||
"additionalProperties": {
|
|
||||||
"oneOf": [
|
|
||||||
{
|
|
||||||
"type": "null"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "boolean"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "number"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "array"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "object"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"description": "New configuration parameters (merged with existing)"
|
|
||||||
},
|
|
||||||
"attributes": {
|
|
||||||
"type": "object",
|
|
||||||
"additionalProperties": {
|
|
||||||
"type": "array",
|
|
||||||
"items": {
|
|
||||||
"type": "string"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"description": "New attributes for access control"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"additionalProperties": false,
|
|
||||||
"title": "UpdateProviderRequest"
|
|
||||||
},
|
|
||||||
"UpdateProviderResponse": {
|
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"provider": {
|
|
||||||
"$ref": "#/components/schemas/ProviderConnectionInfo",
|
|
||||||
"description": "Updated provider information"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"additionalProperties": false,
|
|
||||||
"required": [
|
|
||||||
"provider"
|
|
||||||
],
|
|
||||||
"title": "UpdateProviderResponse",
|
|
||||||
"description": "Response after updating a provider."
|
|
||||||
},
|
|
||||||
"TestProviderConnectionResponse": {
|
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"success": {
|
|
||||||
"type": "boolean",
|
|
||||||
"description": "Whether the connection test succeeded"
|
|
||||||
},
|
|
||||||
"health": {
|
|
||||||
"type": "object",
|
|
||||||
"additionalProperties": {
|
|
||||||
"oneOf": [
|
|
||||||
{
|
|
||||||
"type": "null"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "boolean"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "number"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "array"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "object"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"description": "Health status from the provider"
|
|
||||||
},
|
|
||||||
"error_message": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "Error message if test failed"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"additionalProperties": false,
|
|
||||||
"required": [
|
|
||||||
"success"
|
|
||||||
],
|
|
||||||
"title": "TestProviderConnectionResponse",
|
|
||||||
"description": "Response from testing a provider connection."
|
|
||||||
},
|
|
||||||
"Order": {
|
"Order": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"enum": [
|
"enum": [
|
||||||
|
|
@ -7338,26 +6700,6 @@
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"title": "Response"
|
"title": "Response"
|
||||||
},
|
},
|
||||||
"HealthInfo": {
|
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"status": {
|
|
||||||
"type": "string",
|
|
||||||
"enum": [
|
|
||||||
"OK",
|
|
||||||
"Error",
|
|
||||||
"Not Implemented"
|
|
||||||
],
|
|
||||||
"description": "Current health status of the service"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"additionalProperties": false,
|
|
||||||
"required": [
|
|
||||||
"status"
|
|
||||||
],
|
|
||||||
"title": "HealthInfo",
|
|
||||||
"description": "Health status information for the service."
|
|
||||||
},
|
|
||||||
"RouteInfo": {
|
"RouteInfo": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
|
|
|
||||||
484
docs/static/llama-stack-spec.yaml
vendored
484
docs/static/llama-stack-spec.yaml
vendored
|
|
@ -12,178 +12,6 @@ info:
|
||||||
servers:
|
servers:
|
||||||
- url: http://any-hosted-llama-stack.com
|
- url: http://any-hosted-llama-stack.com
|
||||||
paths:
|
paths:
|
||||||
/v1/admin/providers/{api}:
|
|
||||||
post:
|
|
||||||
responses:
|
|
||||||
'200':
|
|
||||||
description: >-
|
|
||||||
RegisterProviderResponse with the registered provider info.
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
$ref: '#/components/schemas/RegisterProviderResponse'
|
|
||||||
'400':
|
|
||||||
$ref: '#/components/responses/BadRequest400'
|
|
||||||
'429':
|
|
||||||
$ref: >-
|
|
||||||
#/components/responses/TooManyRequests429
|
|
||||||
'500':
|
|
||||||
$ref: >-
|
|
||||||
#/components/responses/InternalServerError500
|
|
||||||
default:
|
|
||||||
$ref: '#/components/responses/DefaultError'
|
|
||||||
tags:
|
|
||||||
- Providers
|
|
||||||
summary: Register a new dynamic provider.
|
|
||||||
description: >-
|
|
||||||
Register a new dynamic provider.
|
|
||||||
|
|
||||||
Register a new provider instance at runtime. The provider will be validated,
|
|
||||||
|
|
||||||
instantiated, and persisted to the kvstore. Requires appropriate ABAC permissions.
|
|
||||||
parameters:
|
|
||||||
- name: api
|
|
||||||
in: path
|
|
||||||
description: >-
|
|
||||||
API namespace this provider implements (e.g., 'inference', 'vector_io').
|
|
||||||
required: true
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
requestBody:
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
$ref: '#/components/schemas/RegisterProviderRequest'
|
|
||||||
required: true
|
|
||||||
deprecated: false
|
|
||||||
/v1/admin/providers/{api}/{provider_id}:
|
|
||||||
post:
|
|
||||||
responses:
|
|
||||||
'200':
|
|
||||||
description: >-
|
|
||||||
UpdateProviderResponse with updated provider info
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
$ref: '#/components/schemas/UpdateProviderResponse'
|
|
||||||
'400':
|
|
||||||
$ref: '#/components/responses/BadRequest400'
|
|
||||||
'429':
|
|
||||||
$ref: >-
|
|
||||||
#/components/responses/TooManyRequests429
|
|
||||||
'500':
|
|
||||||
$ref: >-
|
|
||||||
#/components/responses/InternalServerError500
|
|
||||||
default:
|
|
||||||
$ref: '#/components/responses/DefaultError'
|
|
||||||
tags:
|
|
||||||
- Providers
|
|
||||||
summary: >-
|
|
||||||
Update an existing provider's configuration.
|
|
||||||
description: >-
|
|
||||||
Update an existing provider's configuration.
|
|
||||||
|
|
||||||
Update the configuration and/or attributes of a dynamic provider. The provider
|
|
||||||
|
|
||||||
will be re-instantiated with the new configuration (hot-reload).
|
|
||||||
parameters:
|
|
||||||
- name: api
|
|
||||||
in: path
|
|
||||||
description: API namespace the provider implements
|
|
||||||
required: true
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
- name: provider_id
|
|
||||||
in: path
|
|
||||||
description: ID of the provider to update
|
|
||||||
required: true
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
requestBody:
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
$ref: '#/components/schemas/UpdateProviderRequest'
|
|
||||||
required: true
|
|
||||||
deprecated: false
|
|
||||||
delete:
|
|
||||||
responses:
|
|
||||||
'200':
|
|
||||||
description: OK
|
|
||||||
'400':
|
|
||||||
$ref: '#/components/responses/BadRequest400'
|
|
||||||
'429':
|
|
||||||
$ref: >-
|
|
||||||
#/components/responses/TooManyRequests429
|
|
||||||
'500':
|
|
||||||
$ref: >-
|
|
||||||
#/components/responses/InternalServerError500
|
|
||||||
default:
|
|
||||||
$ref: '#/components/responses/DefaultError'
|
|
||||||
tags:
|
|
||||||
- Providers
|
|
||||||
summary: Unregister a dynamic provider.
|
|
||||||
description: >-
|
|
||||||
Unregister a dynamic provider.
|
|
||||||
|
|
||||||
Remove a dynamic provider, shutting down its instance and removing it from
|
|
||||||
|
|
||||||
the kvstore.
|
|
||||||
parameters:
|
|
||||||
- name: api
|
|
||||||
in: path
|
|
||||||
description: API namespace the provider implements
|
|
||||||
required: true
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
- name: provider_id
|
|
||||||
in: path
|
|
||||||
description: ID of the provider to unregister.
|
|
||||||
required: true
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
deprecated: false
|
|
||||||
/v1/admin/providers/{api}/{provider_id}/test:
|
|
||||||
post:
|
|
||||||
responses:
|
|
||||||
'200':
|
|
||||||
description: >-
|
|
||||||
TestProviderConnectionResponse with health status.
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
$ref: '#/components/schemas/TestProviderConnectionResponse'
|
|
||||||
'400':
|
|
||||||
$ref: '#/components/responses/BadRequest400'
|
|
||||||
'429':
|
|
||||||
$ref: >-
|
|
||||||
#/components/responses/TooManyRequests429
|
|
||||||
'500':
|
|
||||||
$ref: >-
|
|
||||||
#/components/responses/InternalServerError500
|
|
||||||
default:
|
|
||||||
$ref: '#/components/responses/DefaultError'
|
|
||||||
tags:
|
|
||||||
- Providers
|
|
||||||
summary: Test a provider connection.
|
|
||||||
description: >-
|
|
||||||
Test a provider connection.
|
|
||||||
|
|
||||||
Execute a health check on a provider to verify it is reachable and functioning.
|
|
||||||
parameters:
|
|
||||||
- name: api
|
|
||||||
in: path
|
|
||||||
description: API namespace the provider implements.
|
|
||||||
required: true
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
- name: provider_id
|
|
||||||
in: path
|
|
||||||
description: ID of the provider to test.
|
|
||||||
required: true
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
deprecated: false
|
|
||||||
/v1/chat/completions:
|
/v1/chat/completions:
|
||||||
get:
|
get:
|
||||||
responses:
|
responses:
|
||||||
|
|
@ -934,35 +762,6 @@ paths:
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
deprecated: false
|
deprecated: false
|
||||||
/v1/health:
|
|
||||||
get:
|
|
||||||
responses:
|
|
||||||
'200':
|
|
||||||
description: >-
|
|
||||||
Health information indicating if the service is operational.
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
$ref: '#/components/schemas/HealthInfo'
|
|
||||||
'400':
|
|
||||||
$ref: '#/components/responses/BadRequest400'
|
|
||||||
'429':
|
|
||||||
$ref: >-
|
|
||||||
#/components/responses/TooManyRequests429
|
|
||||||
'500':
|
|
||||||
$ref: >-
|
|
||||||
#/components/responses/InternalServerError500
|
|
||||||
default:
|
|
||||||
$ref: '#/components/responses/DefaultError'
|
|
||||||
tags:
|
|
||||||
- Inspect
|
|
||||||
summary: Get health status.
|
|
||||||
description: >-
|
|
||||||
Get health status.
|
|
||||||
|
|
||||||
Get the current health status of the service.
|
|
||||||
parameters: []
|
|
||||||
deprecated: false
|
|
||||||
/v1/inspect/routes:
|
/v1/inspect/routes:
|
||||||
get:
|
get:
|
||||||
responses:
|
responses:
|
||||||
|
|
@ -3213,273 +3012,6 @@ components:
|
||||||
title: Error
|
title: Error
|
||||||
description: >-
|
description: >-
|
||||||
Error response from the API. Roughly follows RFC 7807.
|
Error response from the API. Roughly follows RFC 7807.
|
||||||
RegisterProviderRequest:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
provider_id:
|
|
||||||
type: string
|
|
||||||
description: >-
|
|
||||||
Unique identifier for this provider instance.
|
|
||||||
provider_type:
|
|
||||||
type: string
|
|
||||||
description: Provider type (e.g., 'remote::openai').
|
|
||||||
config:
|
|
||||||
type: object
|
|
||||||
additionalProperties:
|
|
||||||
oneOf:
|
|
||||||
- type: 'null'
|
|
||||||
- type: boolean
|
|
||||||
- type: number
|
|
||||||
- type: string
|
|
||||||
- type: array
|
|
||||||
- type: object
|
|
||||||
description: >-
|
|
||||||
Provider configuration (API keys, endpoints, etc.).
|
|
||||||
attributes:
|
|
||||||
type: object
|
|
||||||
additionalProperties:
|
|
||||||
type: array
|
|
||||||
items:
|
|
||||||
type: string
|
|
||||||
description: >-
|
|
||||||
Optional attributes for ABAC access control.
|
|
||||||
additionalProperties: false
|
|
||||||
required:
|
|
||||||
- provider_id
|
|
||||||
- provider_type
|
|
||||||
- config
|
|
||||||
title: RegisterProviderRequest
|
|
||||||
ProviderConnectionInfo:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
provider_id:
|
|
||||||
type: string
|
|
||||||
description: >-
|
|
||||||
Unique identifier for this provider instance
|
|
||||||
api:
|
|
||||||
type: string
|
|
||||||
description: >-
|
|
||||||
API namespace (e.g., "inference", "vector_io", "safety")
|
|
||||||
provider_type:
|
|
||||||
type: string
|
|
||||||
description: >-
|
|
||||||
Provider type identifier (e.g., "remote::openai", "inline::faiss")
|
|
||||||
config:
|
|
||||||
type: object
|
|
||||||
additionalProperties:
|
|
||||||
oneOf:
|
|
||||||
- type: 'null'
|
|
||||||
- type: boolean
|
|
||||||
- type: number
|
|
||||||
- type: string
|
|
||||||
- type: array
|
|
||||||
- type: object
|
|
||||||
description: >-
|
|
||||||
Provider-specific configuration (API keys, endpoints, etc.)
|
|
||||||
status:
|
|
||||||
$ref: '#/components/schemas/ProviderConnectionStatus'
|
|
||||||
description: Current connection status
|
|
||||||
health:
|
|
||||||
$ref: '#/components/schemas/ProviderHealth'
|
|
||||||
description: Most recent health check result
|
|
||||||
created_at:
|
|
||||||
type: string
|
|
||||||
format: date-time
|
|
||||||
description: Timestamp when provider was registered
|
|
||||||
updated_at:
|
|
||||||
type: string
|
|
||||||
format: date-time
|
|
||||||
description: Timestamp of last update
|
|
||||||
last_health_check:
|
|
||||||
type: string
|
|
||||||
format: date-time
|
|
||||||
description: Timestamp of last health check
|
|
||||||
error_message:
|
|
||||||
type: string
|
|
||||||
description: Error message if status is failed
|
|
||||||
metadata:
|
|
||||||
type: object
|
|
||||||
additionalProperties:
|
|
||||||
oneOf:
|
|
||||||
- type: 'null'
|
|
||||||
- type: boolean
|
|
||||||
- type: number
|
|
||||||
- type: string
|
|
||||||
- type: array
|
|
||||||
- type: object
|
|
||||||
description: >-
|
|
||||||
User-defined metadata (deprecated, use attributes)
|
|
||||||
owner:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
principal:
|
|
||||||
type: string
|
|
||||||
attributes:
|
|
||||||
type: object
|
|
||||||
additionalProperties:
|
|
||||||
type: array
|
|
||||||
items:
|
|
||||||
type: string
|
|
||||||
additionalProperties: false
|
|
||||||
required:
|
|
||||||
- principal
|
|
||||||
description: >-
|
|
||||||
User who created this provider connection
|
|
||||||
attributes:
|
|
||||||
type: object
|
|
||||||
additionalProperties:
|
|
||||||
type: array
|
|
||||||
items:
|
|
||||||
type: string
|
|
||||||
description: >-
|
|
||||||
Key-value attributes for ABAC access control
|
|
||||||
additionalProperties: false
|
|
||||||
required:
|
|
||||||
- provider_id
|
|
||||||
- api
|
|
||||||
- provider_type
|
|
||||||
- config
|
|
||||||
- status
|
|
||||||
- created_at
|
|
||||||
- updated_at
|
|
||||||
- metadata
|
|
||||||
title: ProviderConnectionInfo
|
|
||||||
description: >-
|
|
||||||
Information about a dynamically managed provider connection.
|
|
||||||
|
|
||||||
This model represents a provider that has been registered at runtime
|
|
||||||
|
|
||||||
via the /providers API, as opposed to static providers configured in run.yaml.
|
|
||||||
|
|
||||||
|
|
||||||
Dynamic providers support full lifecycle management including registration,
|
|
||||||
|
|
||||||
configuration updates, health monitoring, and removal.
|
|
||||||
ProviderConnectionStatus:
|
|
||||||
type: string
|
|
||||||
enum:
|
|
||||||
- pending
|
|
||||||
- initializing
|
|
||||||
- connected
|
|
||||||
- failed
|
|
||||||
- disconnected
|
|
||||||
- testing
|
|
||||||
title: ProviderConnectionStatus
|
|
||||||
description: Status of a dynamic provider connection.
|
|
||||||
ProviderHealth:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
status:
|
|
||||||
type: string
|
|
||||||
enum:
|
|
||||||
- OK
|
|
||||||
- Error
|
|
||||||
- Not Implemented
|
|
||||||
description: >-
|
|
||||||
Health status (OK, ERROR, NOT_IMPLEMENTED)
|
|
||||||
message:
|
|
||||||
type: string
|
|
||||||
description: Optional error or status message
|
|
||||||
metrics:
|
|
||||||
type: object
|
|
||||||
additionalProperties:
|
|
||||||
oneOf:
|
|
||||||
- type: 'null'
|
|
||||||
- type: boolean
|
|
||||||
- type: number
|
|
||||||
- type: string
|
|
||||||
- type: array
|
|
||||||
- type: object
|
|
||||||
description: Provider-specific health metrics
|
|
||||||
last_checked:
|
|
||||||
type: string
|
|
||||||
format: date-time
|
|
||||||
description: Timestamp of last health check
|
|
||||||
additionalProperties: false
|
|
||||||
required:
|
|
||||||
- status
|
|
||||||
- metrics
|
|
||||||
- last_checked
|
|
||||||
title: ProviderHealth
|
|
||||||
description: >-
|
|
||||||
Structured wrapper around provider health status.
|
|
||||||
|
|
||||||
This wraps the existing dict-based HealthResponse for API responses
|
|
||||||
|
|
||||||
while maintaining backward compatibility with existing provider implementations.
|
|
||||||
RegisterProviderResponse:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
provider:
|
|
||||||
$ref: '#/components/schemas/ProviderConnectionInfo'
|
|
||||||
description: >-
|
|
||||||
Information about the registered provider
|
|
||||||
additionalProperties: false
|
|
||||||
required:
|
|
||||||
- provider
|
|
||||||
title: RegisterProviderResponse
|
|
||||||
description: Response after registering a provider.
|
|
||||||
UpdateProviderRequest:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
config:
|
|
||||||
type: object
|
|
||||||
additionalProperties:
|
|
||||||
oneOf:
|
|
||||||
- type: 'null'
|
|
||||||
- type: boolean
|
|
||||||
- type: number
|
|
||||||
- type: string
|
|
||||||
- type: array
|
|
||||||
- type: object
|
|
||||||
description: >-
|
|
||||||
New configuration parameters (merged with existing)
|
|
||||||
attributes:
|
|
||||||
type: object
|
|
||||||
additionalProperties:
|
|
||||||
type: array
|
|
||||||
items:
|
|
||||||
type: string
|
|
||||||
description: New attributes for access control
|
|
||||||
additionalProperties: false
|
|
||||||
title: UpdateProviderRequest
|
|
||||||
UpdateProviderResponse:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
provider:
|
|
||||||
$ref: '#/components/schemas/ProviderConnectionInfo'
|
|
||||||
description: Updated provider information
|
|
||||||
additionalProperties: false
|
|
||||||
required:
|
|
||||||
- provider
|
|
||||||
title: UpdateProviderResponse
|
|
||||||
description: Response after updating a provider.
|
|
||||||
TestProviderConnectionResponse:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
success:
|
|
||||||
type: boolean
|
|
||||||
description: Whether the connection test succeeded
|
|
||||||
health:
|
|
||||||
type: object
|
|
||||||
additionalProperties:
|
|
||||||
oneOf:
|
|
||||||
- type: 'null'
|
|
||||||
- type: boolean
|
|
||||||
- type: number
|
|
||||||
- type: string
|
|
||||||
- type: array
|
|
||||||
- type: object
|
|
||||||
description: Health status from the provider
|
|
||||||
error_message:
|
|
||||||
type: string
|
|
||||||
description: Error message if test failed
|
|
||||||
additionalProperties: false
|
|
||||||
required:
|
|
||||||
- success
|
|
||||||
title: TestProviderConnectionResponse
|
|
||||||
description: >-
|
|
||||||
Response from testing a provider connection.
|
|
||||||
Order:
|
Order:
|
||||||
type: string
|
type: string
|
||||||
enum:
|
enum:
|
||||||
|
|
@ -5533,22 +5065,6 @@ components:
|
||||||
Response:
|
Response:
|
||||||
type: object
|
type: object
|
||||||
title: Response
|
title: Response
|
||||||
HealthInfo:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
status:
|
|
||||||
type: string
|
|
||||||
enum:
|
|
||||||
- OK
|
|
||||||
- Error
|
|
||||||
- Not Implemented
|
|
||||||
description: Current health status of the service
|
|
||||||
additionalProperties: false
|
|
||||||
required:
|
|
||||||
- status
|
|
||||||
title: HealthInfo
|
|
||||||
description: >-
|
|
||||||
Health status information for the service.
|
|
||||||
RouteInfo:
|
RouteInfo:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
|
|
|
||||||
1261
docs/static/stainless-llama-stack-spec.html
vendored
1261
docs/static/stainless-llama-stack-spec.html
vendored
File diff suppressed because it is too large
Load diff
923
docs/static/stainless-llama-stack-spec.yaml
vendored
923
docs/static/stainless-llama-stack-spec.yaml
vendored
|
|
@ -15,178 +15,6 @@ info:
|
||||||
servers:
|
servers:
|
||||||
- url: http://any-hosted-llama-stack.com
|
- url: http://any-hosted-llama-stack.com
|
||||||
paths:
|
paths:
|
||||||
/v1/admin/providers/{api}:
|
|
||||||
post:
|
|
||||||
responses:
|
|
||||||
'200':
|
|
||||||
description: >-
|
|
||||||
RegisterProviderResponse with the registered provider info.
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
$ref: '#/components/schemas/RegisterProviderResponse'
|
|
||||||
'400':
|
|
||||||
$ref: '#/components/responses/BadRequest400'
|
|
||||||
'429':
|
|
||||||
$ref: >-
|
|
||||||
#/components/responses/TooManyRequests429
|
|
||||||
'500':
|
|
||||||
$ref: >-
|
|
||||||
#/components/responses/InternalServerError500
|
|
||||||
default:
|
|
||||||
$ref: '#/components/responses/DefaultError'
|
|
||||||
tags:
|
|
||||||
- Providers
|
|
||||||
summary: Register a new dynamic provider.
|
|
||||||
description: >-
|
|
||||||
Register a new dynamic provider.
|
|
||||||
|
|
||||||
Register a new provider instance at runtime. The provider will be validated,
|
|
||||||
|
|
||||||
instantiated, and persisted to the kvstore. Requires appropriate ABAC permissions.
|
|
||||||
parameters:
|
|
||||||
- name: api
|
|
||||||
in: path
|
|
||||||
description: >-
|
|
||||||
API namespace this provider implements (e.g., 'inference', 'vector_io').
|
|
||||||
required: true
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
requestBody:
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
$ref: '#/components/schemas/RegisterProviderRequest'
|
|
||||||
required: true
|
|
||||||
deprecated: false
|
|
||||||
/v1/admin/providers/{api}/{provider_id}:
|
|
||||||
post:
|
|
||||||
responses:
|
|
||||||
'200':
|
|
||||||
description: >-
|
|
||||||
UpdateProviderResponse with updated provider info
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
$ref: '#/components/schemas/UpdateProviderResponse'
|
|
||||||
'400':
|
|
||||||
$ref: '#/components/responses/BadRequest400'
|
|
||||||
'429':
|
|
||||||
$ref: >-
|
|
||||||
#/components/responses/TooManyRequests429
|
|
||||||
'500':
|
|
||||||
$ref: >-
|
|
||||||
#/components/responses/InternalServerError500
|
|
||||||
default:
|
|
||||||
$ref: '#/components/responses/DefaultError'
|
|
||||||
tags:
|
|
||||||
- Providers
|
|
||||||
summary: >-
|
|
||||||
Update an existing provider's configuration.
|
|
||||||
description: >-
|
|
||||||
Update an existing provider's configuration.
|
|
||||||
|
|
||||||
Update the configuration and/or attributes of a dynamic provider. The provider
|
|
||||||
|
|
||||||
will be re-instantiated with the new configuration (hot-reload).
|
|
||||||
parameters:
|
|
||||||
- name: api
|
|
||||||
in: path
|
|
||||||
description: API namespace the provider implements
|
|
||||||
required: true
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
- name: provider_id
|
|
||||||
in: path
|
|
||||||
description: ID of the provider to update
|
|
||||||
required: true
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
requestBody:
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
$ref: '#/components/schemas/UpdateProviderRequest'
|
|
||||||
required: true
|
|
||||||
deprecated: false
|
|
||||||
delete:
|
|
||||||
responses:
|
|
||||||
'200':
|
|
||||||
description: OK
|
|
||||||
'400':
|
|
||||||
$ref: '#/components/responses/BadRequest400'
|
|
||||||
'429':
|
|
||||||
$ref: >-
|
|
||||||
#/components/responses/TooManyRequests429
|
|
||||||
'500':
|
|
||||||
$ref: >-
|
|
||||||
#/components/responses/InternalServerError500
|
|
||||||
default:
|
|
||||||
$ref: '#/components/responses/DefaultError'
|
|
||||||
tags:
|
|
||||||
- Providers
|
|
||||||
summary: Unregister a dynamic provider.
|
|
||||||
description: >-
|
|
||||||
Unregister a dynamic provider.
|
|
||||||
|
|
||||||
Remove a dynamic provider, shutting down its instance and removing it from
|
|
||||||
|
|
||||||
the kvstore.
|
|
||||||
parameters:
|
|
||||||
- name: api
|
|
||||||
in: path
|
|
||||||
description: API namespace the provider implements
|
|
||||||
required: true
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
- name: provider_id
|
|
||||||
in: path
|
|
||||||
description: ID of the provider to unregister.
|
|
||||||
required: true
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
deprecated: false
|
|
||||||
/v1/admin/providers/{api}/{provider_id}/test:
|
|
||||||
post:
|
|
||||||
responses:
|
|
||||||
'200':
|
|
||||||
description: >-
|
|
||||||
TestProviderConnectionResponse with health status.
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
$ref: '#/components/schemas/TestProviderConnectionResponse'
|
|
||||||
'400':
|
|
||||||
$ref: '#/components/responses/BadRequest400'
|
|
||||||
'429':
|
|
||||||
$ref: >-
|
|
||||||
#/components/responses/TooManyRequests429
|
|
||||||
'500':
|
|
||||||
$ref: >-
|
|
||||||
#/components/responses/InternalServerError500
|
|
||||||
default:
|
|
||||||
$ref: '#/components/responses/DefaultError'
|
|
||||||
tags:
|
|
||||||
- Providers
|
|
||||||
summary: Test a provider connection.
|
|
||||||
description: >-
|
|
||||||
Test a provider connection.
|
|
||||||
|
|
||||||
Execute a health check on a provider to verify it is reachable and functioning.
|
|
||||||
parameters:
|
|
||||||
- name: api
|
|
||||||
in: path
|
|
||||||
description: API namespace the provider implements.
|
|
||||||
required: true
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
- name: provider_id
|
|
||||||
in: path
|
|
||||||
description: ID of the provider to test.
|
|
||||||
required: true
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
deprecated: false
|
|
||||||
/v1/chat/completions:
|
/v1/chat/completions:
|
||||||
get:
|
get:
|
||||||
responses:
|
responses:
|
||||||
|
|
@ -937,35 +765,6 @@ paths:
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
deprecated: false
|
deprecated: false
|
||||||
/v1/health:
|
|
||||||
get:
|
|
||||||
responses:
|
|
||||||
'200':
|
|
||||||
description: >-
|
|
||||||
Health information indicating if the service is operational.
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
$ref: '#/components/schemas/HealthInfo'
|
|
||||||
'400':
|
|
||||||
$ref: '#/components/responses/BadRequest400'
|
|
||||||
'429':
|
|
||||||
$ref: >-
|
|
||||||
#/components/responses/TooManyRequests429
|
|
||||||
'500':
|
|
||||||
$ref: >-
|
|
||||||
#/components/responses/InternalServerError500
|
|
||||||
default:
|
|
||||||
$ref: '#/components/responses/DefaultError'
|
|
||||||
tags:
|
|
||||||
- Inspect
|
|
||||||
summary: Get health status.
|
|
||||||
description: >-
|
|
||||||
Get health status.
|
|
||||||
|
|
||||||
Get the current health status of the service.
|
|
||||||
parameters: []
|
|
||||||
deprecated: false
|
|
||||||
/v1/inspect/routes:
|
/v1/inspect/routes:
|
||||||
get:
|
get:
|
||||||
responses:
|
responses:
|
||||||
|
|
@ -3390,6 +3189,178 @@ paths:
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
deprecated: false
|
deprecated: false
|
||||||
|
/v1alpha/admin/providers/{api}:
|
||||||
|
post:
|
||||||
|
responses:
|
||||||
|
'200':
|
||||||
|
description: >-
|
||||||
|
RegisterProviderResponse with the registered provider info.
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: '#/components/schemas/RegisterProviderResponse'
|
||||||
|
'400':
|
||||||
|
$ref: '#/components/responses/BadRequest400'
|
||||||
|
'429':
|
||||||
|
$ref: >-
|
||||||
|
#/components/responses/TooManyRequests429
|
||||||
|
'500':
|
||||||
|
$ref: >-
|
||||||
|
#/components/responses/InternalServerError500
|
||||||
|
default:
|
||||||
|
$ref: '#/components/responses/DefaultError'
|
||||||
|
tags:
|
||||||
|
- Providers
|
||||||
|
summary: Register a new dynamic provider.
|
||||||
|
description: >-
|
||||||
|
Register a new dynamic provider.
|
||||||
|
|
||||||
|
Register a new provider instance at runtime. The provider will be validated,
|
||||||
|
|
||||||
|
instantiated, and persisted to the kvstore. Requires appropriate ABAC permissions.
|
||||||
|
parameters:
|
||||||
|
- name: api
|
||||||
|
in: path
|
||||||
|
description: >-
|
||||||
|
API namespace this provider implements (e.g., 'inference', 'vector_io').
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
requestBody:
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: '#/components/schemas/RegisterProviderRequest'
|
||||||
|
required: true
|
||||||
|
deprecated: false
|
||||||
|
/v1alpha/admin/providers/{api}/{provider_id}:
|
||||||
|
post:
|
||||||
|
responses:
|
||||||
|
'200':
|
||||||
|
description: >-
|
||||||
|
UpdateProviderResponse with updated provider info
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: '#/components/schemas/UpdateProviderResponse'
|
||||||
|
'400':
|
||||||
|
$ref: '#/components/responses/BadRequest400'
|
||||||
|
'429':
|
||||||
|
$ref: >-
|
||||||
|
#/components/responses/TooManyRequests429
|
||||||
|
'500':
|
||||||
|
$ref: >-
|
||||||
|
#/components/responses/InternalServerError500
|
||||||
|
default:
|
||||||
|
$ref: '#/components/responses/DefaultError'
|
||||||
|
tags:
|
||||||
|
- Providers
|
||||||
|
summary: >-
|
||||||
|
Update an existing provider's configuration.
|
||||||
|
description: >-
|
||||||
|
Update an existing provider's configuration.
|
||||||
|
|
||||||
|
Update the configuration and/or attributes of a dynamic provider. The provider
|
||||||
|
|
||||||
|
will be re-instantiated with the new configuration (hot-reload).
|
||||||
|
parameters:
|
||||||
|
- name: api
|
||||||
|
in: path
|
||||||
|
description: API namespace the provider implements
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
- name: provider_id
|
||||||
|
in: path
|
||||||
|
description: ID of the provider to update
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
requestBody:
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: '#/components/schemas/UpdateProviderRequest'
|
||||||
|
required: true
|
||||||
|
deprecated: false
|
||||||
|
delete:
|
||||||
|
responses:
|
||||||
|
'200':
|
||||||
|
description: OK
|
||||||
|
'400':
|
||||||
|
$ref: '#/components/responses/BadRequest400'
|
||||||
|
'429':
|
||||||
|
$ref: >-
|
||||||
|
#/components/responses/TooManyRequests429
|
||||||
|
'500':
|
||||||
|
$ref: >-
|
||||||
|
#/components/responses/InternalServerError500
|
||||||
|
default:
|
||||||
|
$ref: '#/components/responses/DefaultError'
|
||||||
|
tags:
|
||||||
|
- Providers
|
||||||
|
summary: Unregister a dynamic provider.
|
||||||
|
description: >-
|
||||||
|
Unregister a dynamic provider.
|
||||||
|
|
||||||
|
Remove a dynamic provider, shutting down its instance and removing it from
|
||||||
|
|
||||||
|
the kvstore.
|
||||||
|
parameters:
|
||||||
|
- name: api
|
||||||
|
in: path
|
||||||
|
description: API namespace the provider implements
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
- name: provider_id
|
||||||
|
in: path
|
||||||
|
description: ID of the provider to unregister.
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
deprecated: false
|
||||||
|
/v1alpha/admin/providers/{api}/{provider_id}/health:
|
||||||
|
get:
|
||||||
|
responses:
|
||||||
|
'200':
|
||||||
|
description: >-
|
||||||
|
TestProviderConnectionResponse with health status.
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: '#/components/schemas/TestProviderConnectionResponse'
|
||||||
|
'400':
|
||||||
|
$ref: '#/components/responses/BadRequest400'
|
||||||
|
'429':
|
||||||
|
$ref: >-
|
||||||
|
#/components/responses/TooManyRequests429
|
||||||
|
'500':
|
||||||
|
$ref: >-
|
||||||
|
#/components/responses/InternalServerError500
|
||||||
|
default:
|
||||||
|
$ref: '#/components/responses/DefaultError'
|
||||||
|
tags:
|
||||||
|
- Inspect
|
||||||
|
summary: Check provider health.
|
||||||
|
description: >-
|
||||||
|
Check provider health.
|
||||||
|
|
||||||
|
Execute a health check on a provider to verify it is reachable and functioning.
|
||||||
|
parameters:
|
||||||
|
- name: api
|
||||||
|
in: path
|
||||||
|
description: API namespace the provider implements.
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
- name: provider_id
|
||||||
|
in: path
|
||||||
|
description: ID of the provider to check.
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
deprecated: false
|
||||||
/v1alpha/agents:
|
/v1alpha/agents:
|
||||||
get:
|
get:
|
||||||
responses:
|
responses:
|
||||||
|
|
@ -4426,273 +4397,6 @@ components:
|
||||||
title: Error
|
title: Error
|
||||||
description: >-
|
description: >-
|
||||||
Error response from the API. Roughly follows RFC 7807.
|
Error response from the API. Roughly follows RFC 7807.
|
||||||
RegisterProviderRequest:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
provider_id:
|
|
||||||
type: string
|
|
||||||
description: >-
|
|
||||||
Unique identifier for this provider instance.
|
|
||||||
provider_type:
|
|
||||||
type: string
|
|
||||||
description: Provider type (e.g., 'remote::openai').
|
|
||||||
config:
|
|
||||||
type: object
|
|
||||||
additionalProperties:
|
|
||||||
oneOf:
|
|
||||||
- type: 'null'
|
|
||||||
- type: boolean
|
|
||||||
- type: number
|
|
||||||
- type: string
|
|
||||||
- type: array
|
|
||||||
- type: object
|
|
||||||
description: >-
|
|
||||||
Provider configuration (API keys, endpoints, etc.).
|
|
||||||
attributes:
|
|
||||||
type: object
|
|
||||||
additionalProperties:
|
|
||||||
type: array
|
|
||||||
items:
|
|
||||||
type: string
|
|
||||||
description: >-
|
|
||||||
Optional attributes for ABAC access control.
|
|
||||||
additionalProperties: false
|
|
||||||
required:
|
|
||||||
- provider_id
|
|
||||||
- provider_type
|
|
||||||
- config
|
|
||||||
title: RegisterProviderRequest
|
|
||||||
ProviderConnectionInfo:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
provider_id:
|
|
||||||
type: string
|
|
||||||
description: >-
|
|
||||||
Unique identifier for this provider instance
|
|
||||||
api:
|
|
||||||
type: string
|
|
||||||
description: >-
|
|
||||||
API namespace (e.g., "inference", "vector_io", "safety")
|
|
||||||
provider_type:
|
|
||||||
type: string
|
|
||||||
description: >-
|
|
||||||
Provider type identifier (e.g., "remote::openai", "inline::faiss")
|
|
||||||
config:
|
|
||||||
type: object
|
|
||||||
additionalProperties:
|
|
||||||
oneOf:
|
|
||||||
- type: 'null'
|
|
||||||
- type: boolean
|
|
||||||
- type: number
|
|
||||||
- type: string
|
|
||||||
- type: array
|
|
||||||
- type: object
|
|
||||||
description: >-
|
|
||||||
Provider-specific configuration (API keys, endpoints, etc.)
|
|
||||||
status:
|
|
||||||
$ref: '#/components/schemas/ProviderConnectionStatus'
|
|
||||||
description: Current connection status
|
|
||||||
health:
|
|
||||||
$ref: '#/components/schemas/ProviderHealth'
|
|
||||||
description: Most recent health check result
|
|
||||||
created_at:
|
|
||||||
type: string
|
|
||||||
format: date-time
|
|
||||||
description: Timestamp when provider was registered
|
|
||||||
updated_at:
|
|
||||||
type: string
|
|
||||||
format: date-time
|
|
||||||
description: Timestamp of last update
|
|
||||||
last_health_check:
|
|
||||||
type: string
|
|
||||||
format: date-time
|
|
||||||
description: Timestamp of last health check
|
|
||||||
error_message:
|
|
||||||
type: string
|
|
||||||
description: Error message if status is failed
|
|
||||||
metadata:
|
|
||||||
type: object
|
|
||||||
additionalProperties:
|
|
||||||
oneOf:
|
|
||||||
- type: 'null'
|
|
||||||
- type: boolean
|
|
||||||
- type: number
|
|
||||||
- type: string
|
|
||||||
- type: array
|
|
||||||
- type: object
|
|
||||||
description: >-
|
|
||||||
User-defined metadata (deprecated, use attributes)
|
|
||||||
owner:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
principal:
|
|
||||||
type: string
|
|
||||||
attributes:
|
|
||||||
type: object
|
|
||||||
additionalProperties:
|
|
||||||
type: array
|
|
||||||
items:
|
|
||||||
type: string
|
|
||||||
additionalProperties: false
|
|
||||||
required:
|
|
||||||
- principal
|
|
||||||
description: >-
|
|
||||||
User who created this provider connection
|
|
||||||
attributes:
|
|
||||||
type: object
|
|
||||||
additionalProperties:
|
|
||||||
type: array
|
|
||||||
items:
|
|
||||||
type: string
|
|
||||||
description: >-
|
|
||||||
Key-value attributes for ABAC access control
|
|
||||||
additionalProperties: false
|
|
||||||
required:
|
|
||||||
- provider_id
|
|
||||||
- api
|
|
||||||
- provider_type
|
|
||||||
- config
|
|
||||||
- status
|
|
||||||
- created_at
|
|
||||||
- updated_at
|
|
||||||
- metadata
|
|
||||||
title: ProviderConnectionInfo
|
|
||||||
description: >-
|
|
||||||
Information about a dynamically managed provider connection.
|
|
||||||
|
|
||||||
This model represents a provider that has been registered at runtime
|
|
||||||
|
|
||||||
via the /providers API, as opposed to static providers configured in run.yaml.
|
|
||||||
|
|
||||||
|
|
||||||
Dynamic providers support full lifecycle management including registration,
|
|
||||||
|
|
||||||
configuration updates, health monitoring, and removal.
|
|
||||||
ProviderConnectionStatus:
|
|
||||||
type: string
|
|
||||||
enum:
|
|
||||||
- pending
|
|
||||||
- initializing
|
|
||||||
- connected
|
|
||||||
- failed
|
|
||||||
- disconnected
|
|
||||||
- testing
|
|
||||||
title: ProviderConnectionStatus
|
|
||||||
description: Status of a dynamic provider connection.
|
|
||||||
ProviderHealth:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
status:
|
|
||||||
type: string
|
|
||||||
enum:
|
|
||||||
- OK
|
|
||||||
- Error
|
|
||||||
- Not Implemented
|
|
||||||
description: >-
|
|
||||||
Health status (OK, ERROR, NOT_IMPLEMENTED)
|
|
||||||
message:
|
|
||||||
type: string
|
|
||||||
description: Optional error or status message
|
|
||||||
metrics:
|
|
||||||
type: object
|
|
||||||
additionalProperties:
|
|
||||||
oneOf:
|
|
||||||
- type: 'null'
|
|
||||||
- type: boolean
|
|
||||||
- type: number
|
|
||||||
- type: string
|
|
||||||
- type: array
|
|
||||||
- type: object
|
|
||||||
description: Provider-specific health metrics
|
|
||||||
last_checked:
|
|
||||||
type: string
|
|
||||||
format: date-time
|
|
||||||
description: Timestamp of last health check
|
|
||||||
additionalProperties: false
|
|
||||||
required:
|
|
||||||
- status
|
|
||||||
- metrics
|
|
||||||
- last_checked
|
|
||||||
title: ProviderHealth
|
|
||||||
description: >-
|
|
||||||
Structured wrapper around provider health status.
|
|
||||||
|
|
||||||
This wraps the existing dict-based HealthResponse for API responses
|
|
||||||
|
|
||||||
while maintaining backward compatibility with existing provider implementations.
|
|
||||||
RegisterProviderResponse:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
provider:
|
|
||||||
$ref: '#/components/schemas/ProviderConnectionInfo'
|
|
||||||
description: >-
|
|
||||||
Information about the registered provider
|
|
||||||
additionalProperties: false
|
|
||||||
required:
|
|
||||||
- provider
|
|
||||||
title: RegisterProviderResponse
|
|
||||||
description: Response after registering a provider.
|
|
||||||
UpdateProviderRequest:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
config:
|
|
||||||
type: object
|
|
||||||
additionalProperties:
|
|
||||||
oneOf:
|
|
||||||
- type: 'null'
|
|
||||||
- type: boolean
|
|
||||||
- type: number
|
|
||||||
- type: string
|
|
||||||
- type: array
|
|
||||||
- type: object
|
|
||||||
description: >-
|
|
||||||
New configuration parameters (merged with existing)
|
|
||||||
attributes:
|
|
||||||
type: object
|
|
||||||
additionalProperties:
|
|
||||||
type: array
|
|
||||||
items:
|
|
||||||
type: string
|
|
||||||
description: New attributes for access control
|
|
||||||
additionalProperties: false
|
|
||||||
title: UpdateProviderRequest
|
|
||||||
UpdateProviderResponse:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
provider:
|
|
||||||
$ref: '#/components/schemas/ProviderConnectionInfo'
|
|
||||||
description: Updated provider information
|
|
||||||
additionalProperties: false
|
|
||||||
required:
|
|
||||||
- provider
|
|
||||||
title: UpdateProviderResponse
|
|
||||||
description: Response after updating a provider.
|
|
||||||
TestProviderConnectionResponse:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
success:
|
|
||||||
type: boolean
|
|
||||||
description: Whether the connection test succeeded
|
|
||||||
health:
|
|
||||||
type: object
|
|
||||||
additionalProperties:
|
|
||||||
oneOf:
|
|
||||||
- type: 'null'
|
|
||||||
- type: boolean
|
|
||||||
- type: number
|
|
||||||
- type: string
|
|
||||||
- type: array
|
|
||||||
- type: object
|
|
||||||
description: Health status from the provider
|
|
||||||
error_message:
|
|
||||||
type: string
|
|
||||||
description: Error message if test failed
|
|
||||||
additionalProperties: false
|
|
||||||
required:
|
|
||||||
- success
|
|
||||||
title: TestProviderConnectionResponse
|
|
||||||
description: >-
|
|
||||||
Response from testing a provider connection.
|
|
||||||
Order:
|
Order:
|
||||||
type: string
|
type: string
|
||||||
enum:
|
enum:
|
||||||
|
|
@ -6746,22 +6450,6 @@ components:
|
||||||
Response:
|
Response:
|
||||||
type: object
|
type: object
|
||||||
title: Response
|
title: Response
|
||||||
HealthInfo:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
status:
|
|
||||||
type: string
|
|
||||||
enum:
|
|
||||||
- OK
|
|
||||||
- Error
|
|
||||||
- Not Implemented
|
|
||||||
description: Current health status of the service
|
|
||||||
additionalProperties: false
|
|
||||||
required:
|
|
||||||
- status
|
|
||||||
title: HealthInfo
|
|
||||||
description: >-
|
|
||||||
Health status information for the service.
|
|
||||||
RouteInfo:
|
RouteInfo:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
|
|
@ -11876,6 +11564,273 @@ components:
|
||||||
- purpose
|
- purpose
|
||||||
- source
|
- source
|
||||||
title: RegisterDatasetRequest
|
title: RegisterDatasetRequest
|
||||||
|
RegisterProviderRequest:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
provider_id:
|
||||||
|
type: string
|
||||||
|
description: >-
|
||||||
|
Unique identifier for this provider instance.
|
||||||
|
provider_type:
|
||||||
|
type: string
|
||||||
|
description: Provider type (e.g., 'remote::openai').
|
||||||
|
config:
|
||||||
|
type: object
|
||||||
|
additionalProperties:
|
||||||
|
oneOf:
|
||||||
|
- type: 'null'
|
||||||
|
- type: boolean
|
||||||
|
- type: number
|
||||||
|
- type: string
|
||||||
|
- type: array
|
||||||
|
- type: object
|
||||||
|
description: >-
|
||||||
|
Provider configuration (API keys, endpoints, etc.).
|
||||||
|
attributes:
|
||||||
|
type: object
|
||||||
|
additionalProperties:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
description: >-
|
||||||
|
Optional attributes for ABAC access control.
|
||||||
|
additionalProperties: false
|
||||||
|
required:
|
||||||
|
- provider_id
|
||||||
|
- provider_type
|
||||||
|
- config
|
||||||
|
title: RegisterProviderRequest
|
||||||
|
ProviderConnectionInfo:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
provider_id:
|
||||||
|
type: string
|
||||||
|
description: >-
|
||||||
|
Unique identifier for this provider instance
|
||||||
|
api:
|
||||||
|
type: string
|
||||||
|
description: >-
|
||||||
|
API namespace (e.g., "inference", "vector_io", "safety")
|
||||||
|
provider_type:
|
||||||
|
type: string
|
||||||
|
description: >-
|
||||||
|
Provider type identifier (e.g., "remote::openai", "inline::faiss")
|
||||||
|
config:
|
||||||
|
type: object
|
||||||
|
additionalProperties:
|
||||||
|
oneOf:
|
||||||
|
- type: 'null'
|
||||||
|
- type: boolean
|
||||||
|
- type: number
|
||||||
|
- type: string
|
||||||
|
- type: array
|
||||||
|
- type: object
|
||||||
|
description: >-
|
||||||
|
Provider-specific configuration (API keys, endpoints, etc.)
|
||||||
|
status:
|
||||||
|
$ref: '#/components/schemas/ProviderConnectionStatus'
|
||||||
|
description: Current connection status
|
||||||
|
health:
|
||||||
|
$ref: '#/components/schemas/ProviderHealth'
|
||||||
|
description: Most recent health check result
|
||||||
|
created_at:
|
||||||
|
type: string
|
||||||
|
format: date-time
|
||||||
|
description: Timestamp when provider was registered
|
||||||
|
updated_at:
|
||||||
|
type: string
|
||||||
|
format: date-time
|
||||||
|
description: Timestamp of last update
|
||||||
|
last_health_check:
|
||||||
|
type: string
|
||||||
|
format: date-time
|
||||||
|
description: Timestamp of last health check
|
||||||
|
error_message:
|
||||||
|
type: string
|
||||||
|
description: Error message if status is failed
|
||||||
|
metadata:
|
||||||
|
type: object
|
||||||
|
additionalProperties:
|
||||||
|
oneOf:
|
||||||
|
- type: 'null'
|
||||||
|
- type: boolean
|
||||||
|
- type: number
|
||||||
|
- type: string
|
||||||
|
- type: array
|
||||||
|
- type: object
|
||||||
|
description: >-
|
||||||
|
User-defined metadata (deprecated, use attributes)
|
||||||
|
owner:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
principal:
|
||||||
|
type: string
|
||||||
|
attributes:
|
||||||
|
type: object
|
||||||
|
additionalProperties:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
additionalProperties: false
|
||||||
|
required:
|
||||||
|
- principal
|
||||||
|
description: >-
|
||||||
|
User who created this provider connection
|
||||||
|
attributes:
|
||||||
|
type: object
|
||||||
|
additionalProperties:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
description: >-
|
||||||
|
Key-value attributes for ABAC access control
|
||||||
|
additionalProperties: false
|
||||||
|
required:
|
||||||
|
- provider_id
|
||||||
|
- api
|
||||||
|
- provider_type
|
||||||
|
- config
|
||||||
|
- status
|
||||||
|
- created_at
|
||||||
|
- updated_at
|
||||||
|
- metadata
|
||||||
|
title: ProviderConnectionInfo
|
||||||
|
description: >-
|
||||||
|
Information about a dynamically managed provider connection.
|
||||||
|
|
||||||
|
This model represents a provider that has been registered at runtime
|
||||||
|
|
||||||
|
via the /providers API, as opposed to static providers configured in run.yaml.
|
||||||
|
|
||||||
|
|
||||||
|
Dynamic providers support full lifecycle management including registration,
|
||||||
|
|
||||||
|
configuration updates, health monitoring, and removal.
|
||||||
|
ProviderConnectionStatus:
|
||||||
|
type: string
|
||||||
|
enum:
|
||||||
|
- pending
|
||||||
|
- initializing
|
||||||
|
- connected
|
||||||
|
- failed
|
||||||
|
- disconnected
|
||||||
|
- testing
|
||||||
|
title: ProviderConnectionStatus
|
||||||
|
description: Status of a dynamic provider connection.
|
||||||
|
ProviderHealth:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
status:
|
||||||
|
type: string
|
||||||
|
enum:
|
||||||
|
- OK
|
||||||
|
- Error
|
||||||
|
- Not Implemented
|
||||||
|
description: >-
|
||||||
|
Health status (OK, ERROR, NOT_IMPLEMENTED)
|
||||||
|
message:
|
||||||
|
type: string
|
||||||
|
description: Optional error or status message
|
||||||
|
metrics:
|
||||||
|
type: object
|
||||||
|
additionalProperties:
|
||||||
|
oneOf:
|
||||||
|
- type: 'null'
|
||||||
|
- type: boolean
|
||||||
|
- type: number
|
||||||
|
- type: string
|
||||||
|
- type: array
|
||||||
|
- type: object
|
||||||
|
description: Provider-specific health metrics
|
||||||
|
last_checked:
|
||||||
|
type: string
|
||||||
|
format: date-time
|
||||||
|
description: Timestamp of last health check
|
||||||
|
additionalProperties: false
|
||||||
|
required:
|
||||||
|
- status
|
||||||
|
- metrics
|
||||||
|
- last_checked
|
||||||
|
title: ProviderHealth
|
||||||
|
description: >-
|
||||||
|
Structured wrapper around provider health status.
|
||||||
|
|
||||||
|
This wraps the existing dict-based HealthResponse for API responses
|
||||||
|
|
||||||
|
while maintaining backward compatibility with existing provider implementations.
|
||||||
|
RegisterProviderResponse:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
provider:
|
||||||
|
$ref: '#/components/schemas/ProviderConnectionInfo'
|
||||||
|
description: >-
|
||||||
|
Information about the registered provider
|
||||||
|
additionalProperties: false
|
||||||
|
required:
|
||||||
|
- provider
|
||||||
|
title: RegisterProviderResponse
|
||||||
|
description: Response after registering a provider.
|
||||||
|
UpdateProviderRequest:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
config:
|
||||||
|
type: object
|
||||||
|
additionalProperties:
|
||||||
|
oneOf:
|
||||||
|
- type: 'null'
|
||||||
|
- type: boolean
|
||||||
|
- type: number
|
||||||
|
- type: string
|
||||||
|
- type: array
|
||||||
|
- type: object
|
||||||
|
description: >-
|
||||||
|
New configuration parameters (merged with existing)
|
||||||
|
attributes:
|
||||||
|
type: object
|
||||||
|
additionalProperties:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
description: New attributes for access control
|
||||||
|
additionalProperties: false
|
||||||
|
title: UpdateProviderRequest
|
||||||
|
UpdateProviderResponse:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
provider:
|
||||||
|
$ref: '#/components/schemas/ProviderConnectionInfo'
|
||||||
|
description: Updated provider information
|
||||||
|
additionalProperties: false
|
||||||
|
required:
|
||||||
|
- provider
|
||||||
|
title: UpdateProviderResponse
|
||||||
|
description: Response after updating a provider.
|
||||||
|
TestProviderConnectionResponse:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
success:
|
||||||
|
type: boolean
|
||||||
|
description: Whether the connection test succeeded
|
||||||
|
health:
|
||||||
|
type: object
|
||||||
|
additionalProperties:
|
||||||
|
oneOf:
|
||||||
|
- type: 'null'
|
||||||
|
- type: boolean
|
||||||
|
- type: number
|
||||||
|
- type: string
|
||||||
|
- type: array
|
||||||
|
- type: object
|
||||||
|
description: Health status from the provider
|
||||||
|
error_message:
|
||||||
|
type: string
|
||||||
|
description: Error message if test failed
|
||||||
|
additionalProperties: false
|
||||||
|
required:
|
||||||
|
- success
|
||||||
|
title: TestProviderConnectionResponse
|
||||||
|
description: >-
|
||||||
|
Response from testing a provider connection.
|
||||||
AgentConfig:
|
AgentConfig:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
|
|
|
||||||
|
|
@ -282,9 +282,7 @@ class TestDynamicProviderManagement:
|
||||||
)
|
)
|
||||||
|
|
||||||
# Test connection
|
# Test connection
|
||||||
response = await provider_impl.health(
|
response = await provider_impl.health(api=Api.inference.value, provider_id="test-unhealthy")
|
||||||
api=Api.inference.value, provider_id="test-unhealthy"
|
|
||||||
)
|
|
||||||
|
|
||||||
# Verify response shows unhealthy status
|
# Verify response shows unhealthy status
|
||||||
assert response.success is False
|
assert response.success is False
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue