Skip to content

[NA] [SDK] [DOCS] Update automatically OpenAPI spec and Fern code #3225

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[NA] [SDK] [DOCS] Update automatically OpenAPI spec and Fern code #3225

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
33 changes: 33 additions & 0 deletions apps/opik-documentation/documentation/fern/openapi/opik.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7310,6 +7310,12 @@ components:
name:
minLength: 1
type: string
description:
maxLength: 255
minLength: 0
type: string
description: Optional description for the feedback definition
example: This feedback definition is used to rate response quality
createdAt:
type: string
format: date-time
Expand Down Expand Up @@ -7405,6 +7411,12 @@ components:
name:
minLength: 1
type: string
description:
maxLength: 255
minLength: 0
type: string
description: Optional description for the feedback definition
example: This feedback definition is used to rate response quality
type:
type: string
enum:
Expand Down Expand Up @@ -7502,6 +7514,12 @@ components:
name:
minLength: 1
type: string
description:
maxLength: 255
minLength: 0
type: string
description: Optional description for the feedback definition
example: This feedback definition is used to rate response quality
createdAt:
type: string
format: date-time
Expand Down Expand Up @@ -7575,6 +7593,12 @@ components:
name:
minLength: 1
type: string
description:
maxLength: 255
minLength: 0
type: string
description: Optional description for the feedback definition
example: This feedback definition is used to rate response quality
createdAt:
type: string
format: date-time
Expand Down Expand Up @@ -7634,6 +7658,12 @@ components:
name:
minLength: 1
type: string
description:
maxLength: 255
minLength: 0
type: string
description: Optional description for the feedback definition
example: This feedback definition is used to rate response quality
type:
type: string
enum:
Expand Down Expand Up @@ -8928,6 +8958,7 @@ components:
ServiceTogglesConfig:
required:
- guardrailsEnabled
- humanAnnotationEnabled
- opikAIEnabled
- pythonEvaluatorEnabled
- traceThreadPythonEvaluatorEnabled
Expand All @@ -8941,6 +8972,8 @@ components:
type: boolean
opikAIEnabled:
type: boolean
humanAnnotationEnabled:
type: boolean
ErrorInfo_Write:
required:
- exception_type
Expand Down
33 changes: 33 additions & 0 deletions sdks/code_generation/fern/openapi/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7310,6 +7310,12 @@ components:
name:
minLength: 1
type: string
description:
maxLength: 255
minLength: 0
type: string
description: Optional description for the feedback definition
example: This feedback definition is used to rate response quality
createdAt:
type: string
format: date-time
Expand Down Expand Up @@ -7405,6 +7411,12 @@ components:
name:
minLength: 1
type: string
description:
maxLength: 255
minLength: 0
type: string
description: Optional description for the feedback definition
example: This feedback definition is used to rate response quality
type:
type: string
enum:
Expand Down Expand Up @@ -7502,6 +7514,12 @@ components:
name:
minLength: 1
type: string
description:
maxLength: 255
minLength: 0
type: string
description: Optional description for the feedback definition
example: This feedback definition is used to rate response quality
createdAt:
type: string
format: date-time
Expand Down Expand Up @@ -7575,6 +7593,12 @@ components:
name:
minLength: 1
type: string
description:
maxLength: 255
minLength: 0
type: string
description: Optional description for the feedback definition
example: This feedback definition is used to rate response quality
createdAt:
type: string
format: date-time
Expand Down Expand Up @@ -7634,6 +7658,12 @@ components:
name:
minLength: 1
type: string
description:
maxLength: 255
minLength: 0
type: string
description: Optional description for the feedback definition
example: This feedback definition is used to rate response quality
type:
type: string
enum:
Expand Down Expand Up @@ -8928,6 +8958,7 @@ components:
ServiceTogglesConfig:
required:
- guardrailsEnabled
- humanAnnotationEnabled
- opikAIEnabled
- pythonEvaluatorEnabled
- traceThreadPythonEvaluatorEnabled
Expand All @@ -8941,6 +8972,8 @@ components:
type: boolean
opikAIEnabled:
type: boolean
humanAnnotationEnabled:
type: boolean
ErrorInfo_Write:
required:
- exception_type
Expand Down
5 changes: 5 additions & 0 deletions sdks/python/src/opik/rest_api/types/feedback.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,11 @@
class Base(UniversalBaseModel):
id: typing.Optional[str] = None
name: str
description: typing.Optional[str] = pydantic.Field(default=None)
"""
Optional description for the feedback definition
"""

created_at: typing_extensions.Annotated[typing.Optional[dt.datetime], FieldMetadata(alias="createdAt")] = None
created_by: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="createdBy")] = None
last_updated_at: typing_extensions.Annotated[typing.Optional[dt.datetime], FieldMetadata(alias="lastUpdatedAt")] = (
Expand Down
4 changes: 4 additions & 0 deletions sdks/python/src/opik/rest_api/types/feedback_create.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@
class Base(UniversalBaseModel):
id: typing.Optional[str] = None
name: str
description: typing.Optional[str] = pydantic.Field(default=None)
"""
Optional description for the feedback definition
"""

if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
Expand Down
5 changes: 5 additions & 0 deletions sdks/python/src/opik/rest_api/types/feedback_object_public.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,11 @@
class Base(UniversalBaseModel):
id: typing.Optional[str] = None
name: str
description: typing.Optional[str] = pydantic.Field(default=None)
"""
Optional description for the feedback definition
"""

created_at: typing_extensions.Annotated[typing.Optional[dt.datetime], FieldMetadata(alias="createdAt")] = None
created_by: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="createdBy")] = None
last_updated_at: typing_extensions.Annotated[typing.Optional[dt.datetime], FieldMetadata(alias="lastUpdatedAt")] = (
Expand Down
5 changes: 5 additions & 0 deletions sdks/python/src/opik/rest_api/types/feedback_public.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,11 @@
class Base(UniversalBaseModel):
id: typing.Optional[str] = None
name: str
description: typing.Optional[str] = pydantic.Field(default=None)
"""
Optional description for the feedback definition
"""

created_at: typing_extensions.Annotated[typing.Optional[dt.datetime], FieldMetadata(alias="createdAt")] = None
created_by: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="createdBy")] = None
last_updated_at: typing_extensions.Annotated[typing.Optional[dt.datetime], FieldMetadata(alias="lastUpdatedAt")] = (
Expand Down
4 changes: 4 additions & 0 deletions sdks/python/src/opik/rest_api/types/feedback_update.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@
class Base(UniversalBaseModel):
id: typing.Optional[str] = None
name: str
description: typing.Optional[str] = pydantic.Field(default=None)
"""
Optional description for the feedback definition
"""

if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
Expand Down
1 change: 1 addition & 0 deletions sdks/python/src/opik/rest_api/types/service_toggles_config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ class ServiceTogglesConfig(UniversalBaseModel):
]
guardrails_enabled: typing_extensions.Annotated[bool, FieldMetadata(alias="guardrailsEnabled")]
opik_ai_enabled: typing_extensions.Annotated[bool, FieldMetadata(alias="opikAIEnabled")]
human_annotation_enabled: typing_extensions.Annotated[bool, FieldMetadata(alias="humanAnnotationEnabled")]

if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
Expand Down
2 changes: 2 additions & 0 deletions sdks/typescript/src/opik/rest_api/api/types/Feedback.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ export namespace Feedback {
export interface _Base {
id?: string;
name: string;
/** Optional description for the feedback definition */
description?: string;
createdAt?: Date;
createdBy?: string;
lastUpdatedAt?: Date;
Expand Down
2 changes: 2 additions & 0 deletions sdks/typescript/src/opik/rest_api/api/types/FeedbackCreate.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,7 @@ export namespace FeedbackCreate {
export interface _Base {
id?: string;
name: string;
/** Optional description for the feedback definition */
description?: string;
}
}
2 changes: 2 additions & 0 deletions sdks/typescript/src/opik/rest_api/api/types/FeedbackObjectPublic.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ export namespace FeedbackObjectPublic {
export interface _Base {
id?: string;
name: string;
/** Optional description for the feedback definition */
description?: string;
createdAt?: Date;
createdBy?: string;
lastUpdatedAt?: Date;
Expand Down
2 changes: 2 additions & 0 deletions sdks/typescript/src/opik/rest_api/api/types/FeedbackPublic.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ export namespace FeedbackPublic {
export interface _Base {
id?: string;
name: string;
/** Optional description for the feedback definition */
description?: string;
createdAt?: Date;
createdBy?: string;
lastUpdatedAt?: Date;
Expand Down
2 changes: 2 additions & 0 deletions sdks/typescript/src/opik/rest_api/api/types/FeedbackUpdate.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,7 @@ export namespace FeedbackUpdate {
export interface _Base {
id?: string;
name: string;
/** Optional description for the feedback definition */
description?: string;
}
}
1 change: 1 addition & 0 deletions sdks/typescript/src/opik/rest_api/api/types/ServiceTogglesConfig.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,5 @@ export interface ServiceTogglesConfig {
traceThreadPythonEvaluatorEnabled: boolean;
guardrailsEnabled: boolean;
opikAiEnabled: boolean;
humanAnnotationEnabled: boolean;
}
2 changes: 2 additions & 0 deletions sdks/typescript/src/opik/rest_api/serialization/types/Feedback.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import { CategoricalFeedbackDefinition } from "./CategoricalFeedbackDefinition";
const _Base = core.serialization.object({
id: core.serialization.string().optional(),
name: core.serialization.string(),
description: core.serialization.string().optional(),
createdAt: core.serialization.date().optional(),
createdBy: core.serialization.string().optional(),
lastUpdatedAt: core.serialization.date().optional(),
Expand Down Expand Up @@ -40,6 +41,7 @@ export declare namespace Feedback {
export interface _Base {
id?: string | null;
name: string;
description?: string | null;
createdAt?: string | null;
createdBy?: string | null;
lastUpdatedAt?: string | null;
Expand Down
2 changes: 2 additions & 0 deletions sdks/typescript/src/opik/rest_api/serialization/types/FeedbackCreate.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import { CategoricalFeedbackDefinitionCreate } from "./CategoricalFeedbackDefini
const _Base = core.serialization.object({
id: core.serialization.string().optional(),
name: core.serialization.string(),
description: core.serialization.string().optional(),
});
export const FeedbackCreate: core.serialization.Schema<serializers.FeedbackCreate.Raw, OpikApi.FeedbackCreate> =
core.serialization
Expand All @@ -37,5 +38,6 @@ export declare namespace FeedbackCreate {
export interface _Base {
id?: string | null;
name: string;
description?: string | null;
}
}
2 changes: 2 additions & 0 deletions sdks/typescript/src/opik/rest_api/serialization/types/FeedbackObjectPublic.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import { CategoricalFeedbackDefinitionPublic } from "./CategoricalFeedbackDefini
const _Base = core.serialization.object({
id: core.serialization.string().optional(),
name: core.serialization.string(),
description: core.serialization.string().optional(),
createdAt: core.serialization.date().optional(),
createdBy: core.serialization.string().optional(),
lastUpdatedAt: core.serialization.date().optional(),
Expand Down Expand Up @@ -43,6 +44,7 @@ export declare namespace FeedbackObjectPublic {
export interface _Base {
id?: string | null;
name: string;
description?: string | null;
createdAt?: string | null;
createdBy?: string | null;
lastUpdatedAt?: string | null;
Expand Down
2 changes: 2 additions & 0 deletions sdks/typescript/src/opik/rest_api/serialization/types/FeedbackPublic.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import { CategoricalFeedbackDefinitionPublic } from "./CategoricalFeedbackDefini
const _Base = core.serialization.object({
id: core.serialization.string().optional(),
name: core.serialization.string(),
description: core.serialization.string().optional(),
createdAt: core.serialization.date().optional(),
createdBy: core.serialization.string().optional(),
lastUpdatedAt: core.serialization.date().optional(),
Expand Down Expand Up @@ -41,6 +42,7 @@ export declare namespace FeedbackPublic {
export interface _Base {
id?: string | null;
name: string;
description?: string | null;
createdAt?: string | null;
createdBy?: string | null;
lastUpdatedAt?: string | null;
Expand Down
2 changes: 2 additions & 0 deletions sdks/typescript/src/opik/rest_api/serialization/types/FeedbackUpdate.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import { CategoricalFeedbackDefinitionUpdate } from "./CategoricalFeedbackDefini
const _Base = core.serialization.object({
id: core.serialization.string().optional(),
name: core.serialization.string(),
description: core.serialization.string().optional(),
});
export const FeedbackUpdate: core.serialization.Schema<serializers.FeedbackUpdate.Raw, OpikApi.FeedbackUpdate> =
core.serialization
Expand All @@ -37,5 +38,6 @@ export declare namespace FeedbackUpdate {
export interface _Base {
id?: string | null;
name: string;
description?: string | null;
}
}
2 changes: 2 additions & 0 deletions sdks/typescript/src/opik/rest_api/serialization/types/ServiceTogglesConfig.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ export const ServiceTogglesConfig: core.serialization.ObjectSchema<
traceThreadPythonEvaluatorEnabled: core.serialization.boolean(),
guardrailsEnabled: core.serialization.boolean(),
opikAiEnabled: core.serialization.property("opikAIEnabled", core.serialization.boolean()),
humanAnnotationEnabled: core.serialization.boolean(),
});

export declare namespace ServiceTogglesConfig {
Expand All @@ -22,5 +23,6 @@ export declare namespace ServiceTogglesConfig {
traceThreadPythonEvaluatorEnabled: boolean;
guardrailsEnabled: boolean;
opikAIEnabled: boolean;
humanAnnotationEnabled: boolean;
}
}