From 5086317604cd314c332a8690424afe32f2182921 Mon Sep 17 00:00:00 2001 From: "Github Actions (andrescrz)" Date: Tue, 9 Sep 2025 00:05:57 +0000 Subject: [PATCH] [NA] [SDK] [DOCS] Update automatically OpenAPI spec and Fern code --- .../documentation/fern/openapi/opik.yaml | 33 +++++++++++++++++++ .../code_generation/fern/openapi/openapi.yaml | 33 +++++++++++++++++++ .../src/opik/rest_api/types/feedback.py | 5 +++ .../opik/rest_api/types/feedback_create.py | 4 +++ .../rest_api/types/feedback_object_public.py | 5 +++ .../opik/rest_api/types/feedback_public.py | 5 +++ .../opik/rest_api/types/feedback_update.py | 4 +++ .../rest_api/types/service_toggles_config.py | 1 + .../src/opik/rest_api/api/types/Feedback.ts | 2 ++ .../opik/rest_api/api/types/FeedbackCreate.ts | 2 ++ .../api/types/FeedbackObjectPublic.ts | 2 ++ .../opik/rest_api/api/types/FeedbackPublic.ts | 2 ++ .../opik/rest_api/api/types/FeedbackUpdate.ts | 2 ++ .../api/types/ServiceTogglesConfig.ts | 1 + .../rest_api/serialization/types/Feedback.ts | 2 ++ .../serialization/types/FeedbackCreate.ts | 2 ++ .../types/FeedbackObjectPublic.ts | 2 ++ .../serialization/types/FeedbackPublic.ts | 2 ++ .../serialization/types/FeedbackUpdate.ts | 2 ++ .../types/ServiceTogglesConfig.ts | 2 ++ 20 files changed, 113 insertions(+) diff --git a/apps/opik-documentation/documentation/fern/openapi/opik.yaml b/apps/opik-documentation/documentation/fern/openapi/opik.yaml index 9f8da7dfce..e088763b1c 100644 --- a/apps/opik-documentation/documentation/fern/openapi/opik.yaml +++ b/apps/opik-documentation/documentation/fern/openapi/opik.yaml @@ -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 @@ -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: @@ -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 @@ -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 @@ -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: @@ -8928,6 +8958,7 @@ components: ServiceTogglesConfig: required: - guardrailsEnabled + - humanAnnotationEnabled - opikAIEnabled - pythonEvaluatorEnabled - traceThreadPythonEvaluatorEnabled @@ -8941,6 +8972,8 @@ components: type: boolean opikAIEnabled: type: boolean + humanAnnotationEnabled: + type: boolean ErrorInfo_Write: required: - exception_type diff --git a/sdks/code_generation/fern/openapi/openapi.yaml b/sdks/code_generation/fern/openapi/openapi.yaml index 9f8da7dfce..e088763b1c 100644 --- a/sdks/code_generation/fern/openapi/openapi.yaml +++ b/sdks/code_generation/fern/openapi/openapi.yaml @@ -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 @@ -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: @@ -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 @@ -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 @@ -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: @@ -8928,6 +8958,7 @@ components: ServiceTogglesConfig: required: - guardrailsEnabled + - humanAnnotationEnabled - opikAIEnabled - pythonEvaluatorEnabled - traceThreadPythonEvaluatorEnabled @@ -8941,6 +8972,8 @@ components: type: boolean opikAIEnabled: type: boolean + humanAnnotationEnabled: + type: boolean ErrorInfo_Write: required: - exception_type diff --git a/sdks/python/src/opik/rest_api/types/feedback.py b/sdks/python/src/opik/rest_api/types/feedback.py index 8d72130b9b..9c5bb7a883 100644 --- a/sdks/python/src/opik/rest_api/types/feedback.py +++ b/sdks/python/src/opik/rest_api/types/feedback.py @@ -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")] = ( diff --git a/sdks/python/src/opik/rest_api/types/feedback_create.py b/sdks/python/src/opik/rest_api/types/feedback_create.py index 0f1a56c8f2..815fc9f22c 100644 --- a/sdks/python/src/opik/rest_api/types/feedback_create.py +++ b/sdks/python/src/opik/rest_api/types/feedback_create.py @@ -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 diff --git a/sdks/python/src/opik/rest_api/types/feedback_object_public.py b/sdks/python/src/opik/rest_api/types/feedback_object_public.py index 5473a847da..28aefe89ff 100644 --- a/sdks/python/src/opik/rest_api/types/feedback_object_public.py +++ b/sdks/python/src/opik/rest_api/types/feedback_object_public.py @@ -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")] = ( diff --git a/sdks/python/src/opik/rest_api/types/feedback_public.py b/sdks/python/src/opik/rest_api/types/feedback_public.py index 57bbab2ee5..adde4c744f 100644 --- a/sdks/python/src/opik/rest_api/types/feedback_public.py +++ b/sdks/python/src/opik/rest_api/types/feedback_public.py @@ -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")] = ( diff --git a/sdks/python/src/opik/rest_api/types/feedback_update.py b/sdks/python/src/opik/rest_api/types/feedback_update.py index 8e4f51d8b9..738852f7ed 100644 --- a/sdks/python/src/opik/rest_api/types/feedback_update.py +++ b/sdks/python/src/opik/rest_api/types/feedback_update.py @@ -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 diff --git a/sdks/python/src/opik/rest_api/types/service_toggles_config.py b/sdks/python/src/opik/rest_api/types/service_toggles_config.py index 33e2469a2a..436338e2b4 100644 --- a/sdks/python/src/opik/rest_api/types/service_toggles_config.py +++ b/sdks/python/src/opik/rest_api/types/service_toggles_config.py @@ -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 diff --git a/sdks/typescript/src/opik/rest_api/api/types/Feedback.ts b/sdks/typescript/src/opik/rest_api/api/types/Feedback.ts index b5cfe98a56..9bb9b23b1c 100644 --- a/sdks/typescript/src/opik/rest_api/api/types/Feedback.ts +++ b/sdks/typescript/src/opik/rest_api/api/types/Feedback.ts @@ -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; diff --git a/sdks/typescript/src/opik/rest_api/api/types/FeedbackCreate.ts b/sdks/typescript/src/opik/rest_api/api/types/FeedbackCreate.ts index fb68905501..303847c3cf 100644 --- a/sdks/typescript/src/opik/rest_api/api/types/FeedbackCreate.ts +++ b/sdks/typescript/src/opik/rest_api/api/types/FeedbackCreate.ts @@ -18,5 +18,7 @@ export namespace FeedbackCreate { export interface _Base { id?: string; name: string; + /** Optional description for the feedback definition */ + description?: string; } } diff --git a/sdks/typescript/src/opik/rest_api/api/types/FeedbackObjectPublic.ts b/sdks/typescript/src/opik/rest_api/api/types/FeedbackObjectPublic.ts index 4f5ff9b09c..895cadcb23 100644 --- a/sdks/typescript/src/opik/rest_api/api/types/FeedbackObjectPublic.ts +++ b/sdks/typescript/src/opik/rest_api/api/types/FeedbackObjectPublic.ts @@ -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; diff --git a/sdks/typescript/src/opik/rest_api/api/types/FeedbackPublic.ts b/sdks/typescript/src/opik/rest_api/api/types/FeedbackPublic.ts index aeb6712b34..11378a795d 100644 --- a/sdks/typescript/src/opik/rest_api/api/types/FeedbackPublic.ts +++ b/sdks/typescript/src/opik/rest_api/api/types/FeedbackPublic.ts @@ -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; diff --git a/sdks/typescript/src/opik/rest_api/api/types/FeedbackUpdate.ts b/sdks/typescript/src/opik/rest_api/api/types/FeedbackUpdate.ts index d605f43715..6fdbb93bbd 100644 --- a/sdks/typescript/src/opik/rest_api/api/types/FeedbackUpdate.ts +++ b/sdks/typescript/src/opik/rest_api/api/types/FeedbackUpdate.ts @@ -18,5 +18,7 @@ export namespace FeedbackUpdate { export interface _Base { id?: string; name: string; + /** Optional description for the feedback definition */ + description?: string; } } diff --git a/sdks/typescript/src/opik/rest_api/api/types/ServiceTogglesConfig.ts b/sdks/typescript/src/opik/rest_api/api/types/ServiceTogglesConfig.ts index e55ccd5990..5051cd2a5d 100644 --- a/sdks/typescript/src/opik/rest_api/api/types/ServiceTogglesConfig.ts +++ b/sdks/typescript/src/opik/rest_api/api/types/ServiceTogglesConfig.ts @@ -7,4 +7,5 @@ export interface ServiceTogglesConfig { traceThreadPythonEvaluatorEnabled: boolean; guardrailsEnabled: boolean; opikAiEnabled: boolean; + humanAnnotationEnabled: boolean; } diff --git a/sdks/typescript/src/opik/rest_api/serialization/types/Feedback.ts b/sdks/typescript/src/opik/rest_api/serialization/types/Feedback.ts index b95a4a8495..408dcbe938 100644 --- a/sdks/typescript/src/opik/rest_api/serialization/types/Feedback.ts +++ b/sdks/typescript/src/opik/rest_api/serialization/types/Feedback.ts @@ -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(), @@ -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; diff --git a/sdks/typescript/src/opik/rest_api/serialization/types/FeedbackCreate.ts b/sdks/typescript/src/opik/rest_api/serialization/types/FeedbackCreate.ts index 5907d04e21..d006fc485c 100644 --- a/sdks/typescript/src/opik/rest_api/serialization/types/FeedbackCreate.ts +++ b/sdks/typescript/src/opik/rest_api/serialization/types/FeedbackCreate.ts @@ -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 = core.serialization @@ -37,5 +38,6 @@ export declare namespace FeedbackCreate { export interface _Base { id?: string | null; name: string; + description?: string | null; } } diff --git a/sdks/typescript/src/opik/rest_api/serialization/types/FeedbackObjectPublic.ts b/sdks/typescript/src/opik/rest_api/serialization/types/FeedbackObjectPublic.ts index b20d5655f0..785ad892a8 100644 --- a/sdks/typescript/src/opik/rest_api/serialization/types/FeedbackObjectPublic.ts +++ b/sdks/typescript/src/opik/rest_api/serialization/types/FeedbackObjectPublic.ts @@ -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(), @@ -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; diff --git a/sdks/typescript/src/opik/rest_api/serialization/types/FeedbackPublic.ts b/sdks/typescript/src/opik/rest_api/serialization/types/FeedbackPublic.ts index c1e5c46830..e7e2390e88 100644 --- a/sdks/typescript/src/opik/rest_api/serialization/types/FeedbackPublic.ts +++ b/sdks/typescript/src/opik/rest_api/serialization/types/FeedbackPublic.ts @@ -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(), @@ -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; diff --git a/sdks/typescript/src/opik/rest_api/serialization/types/FeedbackUpdate.ts b/sdks/typescript/src/opik/rest_api/serialization/types/FeedbackUpdate.ts index 3a670179e0..a8a82d6207 100644 --- a/sdks/typescript/src/opik/rest_api/serialization/types/FeedbackUpdate.ts +++ b/sdks/typescript/src/opik/rest_api/serialization/types/FeedbackUpdate.ts @@ -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 = core.serialization @@ -37,5 +38,6 @@ export declare namespace FeedbackUpdate { export interface _Base { id?: string | null; name: string; + description?: string | null; } } diff --git a/sdks/typescript/src/opik/rest_api/serialization/types/ServiceTogglesConfig.ts b/sdks/typescript/src/opik/rest_api/serialization/types/ServiceTogglesConfig.ts index 6c75410e79..1877104d55 100644 --- a/sdks/typescript/src/opik/rest_api/serialization/types/ServiceTogglesConfig.ts +++ b/sdks/typescript/src/opik/rest_api/serialization/types/ServiceTogglesConfig.ts @@ -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 { @@ -22,5 +23,6 @@ export declare namespace ServiceTogglesConfig { traceThreadPythonEvaluatorEnabled: boolean; guardrailsEnabled: boolean; opikAIEnabled: boolean; + humanAnnotationEnabled: boolean; } }