Skip to content

Update LangCache openapi spec #1931

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 4, 2025
Merged

Update LangCache openapi spec #1931

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
112 changes: 107 additions & 5 deletions content/develop/ai/langcache/api-reference/api.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,18 @@ paths:
'application/json':
schema:
$ref: '#/components/schemas/ForbiddenErrorResponseContent'
'404':
description: Cache not found
content:
'application/json':
schema:
$ref: '#/components/schemas/NotFoundErrorResponseContent'
'424':
description: Failed dependency
content:
'application/json':
schema:
$ref: '#/components/schemas/FailedDependencyErrorResponseContent'
'500':
description: An unexpected error occurred
content:
Expand Down Expand Up @@ -105,6 +117,18 @@ paths:
'application/json':
schema:
$ref: '#/components/schemas/ForbiddenErrorResponseContent'
'404':
description: Cache not found
content:
'application/json':
schema:
$ref: '#/components/schemas/NotFoundErrorResponseContent'
'424':
description: Failed dependency
content:
'application/json':
schema:
$ref: '#/components/schemas/FailedDependencyErrorResponseContent'
'500':
description: An unexpected error occurred
content:
Expand Down Expand Up @@ -156,6 +180,18 @@ paths:
'application/json':
schema:
$ref: '#/components/schemas/ForbiddenErrorResponseContent'
'404':
description: Cache not found
content:
'application/json':
schema:
$ref: '#/components/schemas/NotFoundErrorResponseContent'
'424':
description: Failed dependency
content:
'application/json':
schema:
$ref: '#/components/schemas/FailedDependencyErrorResponseContent'
'500':
description: An unexpected error occurred
content:
Expand Down Expand Up @@ -200,11 +236,17 @@ paths:
schema:
$ref: '#/components/schemas/ForbiddenErrorResponseContent'
'404':
description: Cache entry not found
description: Cache or cache entry not found
content:
'application/json':
schema:
$ref: '#/components/schemas/NotFoundErrorResponseContent'
'424':
description: Failed dependency
content:
'application/json':
schema:
$ref: '#/components/schemas/FailedDependencyErrorResponseContent'
'500':
description: An unexpected error occurred
content:
Expand All @@ -226,13 +268,15 @@ components:
required: true
schema:
type: string
pattern: '^[a-zA-Z0-9]+$'
entryId:
name: entryId
in: path
description: The ID of the cache entry to delete.
required: true
schema:
type: string
pattern: '^[a-f0-9]{32}$'
schemas:
SearchEntriesRequest:
required:
Expand All @@ -242,6 +286,8 @@ components:
prompt:
type: string
description: The prompt to search for in the cache.
minLength: 1
maxLength: 1024
example: How does semantic caching work?
similarityThreshold:
minimum: 0
Expand All @@ -252,8 +298,14 @@ components:
example: 0.9
attributes:
type: object
maxProperties: 5
propertyNames:
pattern: '^[a-zA-Z0-9_-]{1,32}$'
additionalProperties:
type: string
minLength: 1
maxLength: 500
pattern: '^[^,]*$'
description: Key-value pairs of attributes that filter the cache entries. If provided, this endpoint only returns entries that contain all given attributes.
example:
language: en
Expand Down Expand Up @@ -282,7 +334,8 @@ components:
id:
type: string
description: Unique identifier for the cache entry.
example: myIndex:5b84acef3ce360988d1b35adbaaaccb164569b6d79fab04fd888b5fea03fb8f2
pattern: '^[a-f0-9]{32}$'
example: 5b84acef3ce360988d1b35adbaaaccb1
prompt:
type: string
description: The prompt associated with the cache entry.
Expand All @@ -293,8 +346,14 @@ components:
example: Semantic caching stores and retrieves data based on meaning, not exact matches.
attributes:
type: object
maxProperties: 5
propertyNames:
pattern: '^[a-zA-Z0-9_-]{1,32}$'
additionalProperties:
type: string
minLength: 1
maxLength: 500
pattern: '^[^,]*$'
description: The key-value pairs of attributes that are associated with the cache entry.
example:
language: en
Expand All @@ -303,6 +362,8 @@ components:
type: number
description: The similarity metric used for similarity comparison.
format: float
minimum: 0
maximum: 1
example: 0.95
description: A cache entry
SetEntryRequest:
Expand All @@ -315,22 +376,33 @@ components:
example: How does semantic caching work?
type: string
description: The prompt for the entry.
minLength: 1
maxLength: 1024
response:
example: Semantic caching stores and retrieves data based on meaning, not exact matches.
type: string
description: The response to the prompt for the entry.
attributes:
type: object
maxProperties: 5
propertyNames:
pattern: '^[a-zA-Z0-9_-]{1,32}$'
additionalProperties:
type: string
minLength: 1
maxLength: 500
pattern: '^[^,]*$'
description: Key-value pairs of attributes to be associated with the entry. These can be used for filtering when searching for entries. All attribute names that can be associated with an entry must be defined during cache creation.
example:
language: en
topic: ai
ttlMillis:
type: integer
description: The entry's time-to-live, in milliseconds.
description: The entry's time-to-live, in milliseconds. If not set, the cache's default TTL is used.
format: int64
minimum: 1
maximum: 31556952000
example: 60000
description: Request to add a cache entry to the cache
SetEntryResponse:
required:
Expand All @@ -340,6 +412,7 @@ components:
entryId:
type: string
description: The ID of the entry that was added to the cache.
pattern: '^[a-f0-9]{32}$'
description: Response representing a successful cache entry addition
DeleteEntriesRequest:
required:
Expand All @@ -348,8 +421,14 @@ components:
properties:
attributes:
type: object
maxProperties: 5
propertyNames:
pattern: '^[a-zA-Z0-9_-]{1,32}$'
additionalProperties:
type: string
minLength: 1
maxLength: 500
pattern: '^[^,]*$'
description: Key-value pairs of attributes associated with the cache entries to delete. If provided, this endpoint only deletes entries that contain all given attributes. If not provided, this endpoint deletes all entries in the cache.
example:
language: en
Expand Down Expand Up @@ -437,6 +516,31 @@ components:
type: string
enum:
- /errors/unauthorized
FailedDependencyErrorResponseContent:
type: object
properties:
title:
type: string
description: A short summary of the problem type.
example: Failed Dependency
status:
type: integer
default: 424
description: The HTTP status code generated by the origin server.
detail:
type: string
description: An explanation specific to this problem.
type:
$ref: '#/components/schemas/FailedDependencyErrorUri'
required:
- status
- title
- type
FailedDependencyErrorUri:
type: string
enum:
- /errors/embeddings/unauthorized
- /errors/embeddings/too-many-requests
ServiceUnavailableErrorResponseContent:
type: object
properties:
Expand All @@ -462,8 +566,6 @@ components:
enum:
- /errors/cache/unexpected-error
- /errors/cache/authentication
- /errors/embeddings/unauthorized
- /errors/embeddings/too-many-requests
- /errors/embeddings/unexpected-error
NotFoundErrorResponseContent:
type: object
Expand Down
Loading