Skip to content

feat: Add metadata field to request and response #4130

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
+367 −0
Draft

feat: Add metadata field to request and response #4130

Show file tree
Hide file tree
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
114 changes: 114 additions & 0 deletions client-sdks/stainless/openapi.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3909,6 +3909,19 @@ components:
$ref: '#/components/schemas/OpenAIChatCompletionUsage'
description: >-
Token usage information for the completion
metadata:
type: object
additionalProperties:
oneOf:
- type: 'null'
- type: boolean
- type: number
- type: string
- type: array
- type: object
description: >-
(Optional) Set of key-value pairs that were attached to the request.
This metadata is copied from the request.
input_messages:
type: array
items:
Expand Down Expand Up @@ -4619,6 +4632,19 @@ components:
user:
type: string
description: (Optional) The user to use.
metadata:
type: object
additionalProperties:
oneOf:
- type: 'null'
- type: boolean
- type: number
- type: string
- type: array
- type: object
description: >-
(Optional) Set of key-value pairs that can be attached to the request.
This metadata will be included in the response object.
additionalProperties: false
required:
- model
Expand Down Expand Up @@ -4655,6 +4681,19 @@ components:
$ref: '#/components/schemas/OpenAIChatCompletionUsage'
description: >-
Token usage information for the completion
metadata:
type: object
additionalProperties:
oneOf:
- type: 'null'
- type: boolean
- type: number
- type: string
- type: array
- type: object
description: >-
(Optional) Set of key-value pairs that were attached to the request. This
metadata is copied from the request.
additionalProperties: false
required:
- id
Expand Down Expand Up @@ -4694,6 +4733,19 @@ components:
$ref: '#/components/schemas/OpenAIChatCompletionUsage'
description: >-
Token usage information (typically included in final chunk with stream_options)
metadata:
type: object
additionalProperties:
oneOf:
- type: 'null'
- type: boolean
- type: number
- type: string
- type: array
- type: object
description: >-
(Optional) Set of key-value pairs that were attached to the request. This
metadata is copied from the request.
additionalProperties: false
required:
- id
Expand Down Expand Up @@ -4783,6 +4835,19 @@ components:
$ref: '#/components/schemas/OpenAIChatCompletionUsage'
description: >-
Token usage information for the completion
metadata:
type: object
additionalProperties:
oneOf:
- type: 'null'
- type: boolean
- type: number
- type: string
- type: array
- type: object
description: >-
(Optional) Set of key-value pairs that were attached to the request. This
metadata is copied from the request.
input_messages:
type: array
items:
Expand Down Expand Up @@ -4888,6 +4953,19 @@ components:
type: string
description: >-
(Optional) The suffix that should be appended to the completion.
metadata:
type: object
additionalProperties:
oneOf:
- type: 'null'
- type: boolean
- type: number
- type: string
- type: array
- type: object
description: >-
(Optional) Set of key-value pairs that can be attached to the request.
This metadata will be included in the response object.
additionalProperties: false
required:
- model
Expand All @@ -4912,6 +4990,16 @@ components:
type: string
const: text_completion
default: text_completion
metadata:
type: object
additionalProperties:
oneOf:
- type: 'null'
- type: boolean
- type: number
- type: string
- type: array
- type: object
additionalProperties: false
required:
- id
Expand Down Expand Up @@ -5744,6 +5832,19 @@ components:
description: >-
(Optional) A unique identifier representing your end-user, which can help
OpenAI to monitor and detect abuse.
metadata:
type: object
additionalProperties:
oneOf:
- type: 'null'
- type: boolean
- type: number
- type: string
- type: array
- type: object
description: >-
(Optional) Set of key-value pairs that can be attached to the request.
This metadata will be included in the response object.
additionalProperties: false
required:
- model
Expand Down Expand Up @@ -5817,6 +5918,19 @@ components:
usage:
$ref: '#/components/schemas/OpenAIEmbeddingUsage'
description: Usage information
metadata:
type: object
additionalProperties:
oneOf:
- type: 'null'
- type: boolean
- type: number
- type: string
- type: array
- type: object
description: >-
(Optional) Set of key-value pairs that were attached to the request. This
metadata is copied from the request.
additionalProperties: false
required:
- object
Expand Down
114 changes: 114 additions & 0 deletions docs/static/llama-stack-spec.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3193,6 +3193,19 @@ components:
$ref: '#/components/schemas/OpenAIChatCompletionUsage'
description: >-
Token usage information for the completion
metadata:
type: object
additionalProperties:
oneOf:
- type: 'null'
- type: boolean
- type: number
- type: string
- type: array
- type: object
description: >-
(Optional) Set of key-value pairs that were attached to the request.
This metadata is copied from the request.
input_messages:
type: array
items:
Expand Down Expand Up @@ -3903,6 +3916,19 @@ components:
user:
type: string
description: (Optional) The user to use.
metadata:
type: object
additionalProperties:
oneOf:
- type: 'null'
- type: boolean
- type: number
- type: string
- type: array
- type: object
description: >-
(Optional) Set of key-value pairs that can be attached to the request.
This metadata will be included in the response object.
additionalProperties: false
required:
- model
Expand Down Expand Up @@ -3939,6 +3965,19 @@ components:
$ref: '#/components/schemas/OpenAIChatCompletionUsage'
description: >-
Token usage information for the completion
metadata:
type: object
additionalProperties:
oneOf:
- type: 'null'
- type: boolean
- type: number
- type: string
- type: array
- type: object
description: >-
(Optional) Set of key-value pairs that were attached to the request. This
metadata is copied from the request.
additionalProperties: false
required:
- id
Expand Down Expand Up @@ -3978,6 +4017,19 @@ components:
$ref: '#/components/schemas/OpenAIChatCompletionUsage'
description: >-
Token usage information (typically included in final chunk with stream_options)
metadata:
type: object
additionalProperties:
oneOf:
- type: 'null'
- type: boolean
- type: number
- type: string
- type: array
- type: object
description: >-
(Optional) Set of key-value pairs that were attached to the request. This
metadata is copied from the request.
additionalProperties: false
required:
- id
Expand Down Expand Up @@ -4067,6 +4119,19 @@ components:
$ref: '#/components/schemas/OpenAIChatCompletionUsage'
description: >-
Token usage information for the completion
metadata:
type: object
additionalProperties:
oneOf:
- type: 'null'
- type: boolean
- type: number
- type: string
- type: array
- type: object
description: >-
(Optional) Set of key-value pairs that were attached to the request. This
metadata is copied from the request.
input_messages:
type: array
items:
Expand Down Expand Up @@ -4172,6 +4237,19 @@ components:
type: string
description: >-
(Optional) The suffix that should be appended to the completion.
metadata:
type: object
additionalProperties:
oneOf:
- type: 'null'
- type: boolean
- type: number
- type: string
- type: array
- type: object
description: >-
(Optional) Set of key-value pairs that can be attached to the request.
This metadata will be included in the response object.
additionalProperties: false
required:
- model
Expand All @@ -4196,6 +4274,16 @@ components:
type: string
const: text_completion
default: text_completion
metadata:
type: object
additionalProperties:
oneOf:
- type: 'null'
- type: boolean
- type: number
- type: string
- type: array
- type: object
additionalProperties: false
required:
- id
Expand Down Expand Up @@ -5028,6 +5116,19 @@ components:
description: >-
(Optional) A unique identifier representing your end-user, which can help
OpenAI to monitor and detect abuse.
metadata:
type: object
additionalProperties:
oneOf:
- type: 'null'
- type: boolean
- type: number
- type: string
- type: array
- type: object
description: >-
(Optional) Set of key-value pairs that can be attached to the request.
This metadata will be included in the response object.
additionalProperties: false
required:
- model
Expand Down Expand Up @@ -5101,6 +5202,19 @@ components:
usage:
$ref: '#/components/schemas/OpenAIEmbeddingUsage'
description: Usage information
metadata:
type: object
additionalProperties:
oneOf:
- type: 'null'
- type: boolean
- type: number
- type: string
- type: array
- type: object
description: >-
(Optional) Set of key-value pairs that were attached to the request. This
metadata is copied from the request.
additionalProperties: false
required:
- object
Expand Down
Loading