Class: OpenApiOpenAIClient::ApiModelBase

Inherits:
Object
  • Object
show all
Defined in:
lib/openapi_openai/api_model_base.rb

Direct Known Subclasses

AdminApiKey, AdminApiKeyOwner, AdminApiKeysCreateRequest, AdminApiKeysDelete200Response, ApiKeyList, AssistantObject, AssistantObjectToolResources, AssistantObjectToolResourcesCodeInterpreter, AssistantObjectToolResourcesFileSearch, AssistantToolsCode, AssistantToolsFileSearch, AssistantToolsFileSearchFileSearch, AssistantToolsFileSearchTypeOnly, AssistantToolsFunction, AssistantsNamedToolChoice, AssistantsNamedToolChoiceFunction, AuditLog, AuditLogActor, AuditLogActorApiKey, AuditLogActorServiceAccount, AuditLogActorSession, AuditLogActorUser, AuditLogApiKeyCreated, AuditLogApiKeyCreatedData, AuditLogApiKeyDeleted, AuditLogApiKeyUpdated, AuditLogApiKeyUpdatedChangesRequested, AuditLogInviteAccepted, AuditLogInviteSent, AuditLogInviteSentData, AuditLogLoginFailed, AuditLogOrganizationUpdated, AuditLogOrganizationUpdatedChangesRequested, AuditLogOrganizationUpdatedChangesRequestedSettings, AuditLogProject, AuditLogProjectArchived, AuditLogProjectCreated, AuditLogProjectCreatedData, AuditLogProjectUpdated, AuditLogProjectUpdatedChangesRequested, AuditLogRateLimitDeleted, AuditLogRateLimitUpdated, AuditLogRateLimitUpdatedChangesRequested, AuditLogServiceAccountCreated, AuditLogServiceAccountCreatedData, AuditLogServiceAccountDeleted, AuditLogServiceAccountUpdated, AuditLogServiceAccountUpdatedChangesRequested, AuditLogUserAdded, AuditLogUserAddedData, AuditLogUserDeleted, AuditLogUserUpdated, AuditLogUserUpdatedChangesRequested, AutoChunkingStrategy, AutoChunkingStrategyRequestParam, Batch, BatchErrors, BatchErrorsDataInner, BatchRequestCounts, BatchRequestInput, BatchRequestOutput, BatchRequestOutputError, BatchRequestOutputResponse, ChatCompletionFunctionCallOption, ChatCompletionFunctions, ChatCompletionMessageToolCall, ChatCompletionMessageToolCallChunk, ChatCompletionMessageToolCallChunkFunction, ChatCompletionMessageToolCallFunction, ChatCompletionNamedToolChoice, ChatCompletionRequestAssistantMessage, ChatCompletionRequestAssistantMessageAudio, ChatCompletionRequestAssistantMessageFunctionCall, ChatCompletionRequestDeveloperMessage, ChatCompletionRequestFunctionMessage, ChatCompletionRequestMessageContentPartAudio, ChatCompletionRequestMessageContentPartAudioInputAudio, ChatCompletionRequestMessageContentPartImage, ChatCompletionRequestMessageContentPartImageImageUrl, ChatCompletionRequestMessageContentPartRefusal, ChatCompletionRequestMessageContentPartText, ChatCompletionRequestSystemMessage, ChatCompletionRequestToolMessage, ChatCompletionRequestUserMessage, ChatCompletionResponseMessage, ChatCompletionResponseMessageAudio, ChatCompletionResponseMessageFunctionCall, ChatCompletionStreamOptions, ChatCompletionStreamResponseDelta, ChatCompletionStreamResponseDeltaFunctionCall, ChatCompletionTokenLogprob, ChatCompletionTokenLogprobTopLogprobsInner, ChatCompletionTool, CompleteUploadRequest, CompletionUsage, CompletionUsageCompletionTokensDetails, CompletionUsagePromptTokensDetails, CostsResult, CostsResultAmount, CreateAssistantRequest, CreateAssistantRequestToolResources, CreateAssistantRequestToolResourcesCodeInterpreter, CreateAssistantRequestToolResourcesFileSearch, CreateAssistantRequestToolResourcesFileSearchVectorStoresInner, CreateBatchRequest, CreateChatCompletionFunctionResponse, CreateChatCompletionFunctionResponseChoicesInner, CreateChatCompletionRequest, CreateChatCompletionRequestAudio, CreateChatCompletionResponse, CreateChatCompletionResponseChoicesInner, CreateChatCompletionResponseChoicesInnerLogprobs, CreateChatCompletionStreamResponse, CreateChatCompletionStreamResponseChoicesInner, CreateChatCompletionStreamResponseUsage, CreateCompletionRequest, CreateCompletionResponse, CreateCompletionResponseChoicesInner, CreateCompletionResponseChoicesInnerLogprobs, CreateEmbeddingRequest, CreateEmbeddingResponse, CreateEmbeddingResponseUsage, CreateFineTuningJobRequest, CreateFineTuningJobRequestHyperparameters, CreateFineTuningJobRequestIntegrationsInner, CreateFineTuningJobRequestIntegrationsInnerWandb, CreateImageRequest, CreateMessageRequest, CreateMessageRequestAttachmentsInner, CreateModerationRequest, CreateModerationRequestInputOneOfInnerOneOf, CreateModerationRequestInputOneOfInnerOneOf1, CreateModerationRequestInputOneOfInnerOneOfImageUrl, CreateModerationResponse, CreateModerationResponseResultsInner, CreateModerationResponseResultsInnerCategories, CreateModerationResponseResultsInnerCategoryAppliedInputTypes, CreateModerationResponseResultsInnerCategoryScores, CreateRunRequest, CreateSpeechRequest, CreateThreadAndRunRequest, CreateThreadAndRunRequestToolResources, CreateThreadRequest, CreateThreadRequestToolResources, CreateThreadRequestToolResourcesFileSearch, CreateThreadRequestToolResourcesFileSearchVectorStoresInner, CreateTranscriptionResponseJson, CreateTranscriptionResponseVerboseJson, CreateTranslationResponseJson, CreateTranslationResponseVerboseJson, CreateUploadRequest, CreateVectorStoreFileBatchRequest, CreateVectorStoreFileRequest, CreateVectorStoreRequest, DefaultProjectErrorResponse, DeleteAssistantResponse, DeleteFileResponse, DeleteMessageResponse, DeleteModelResponse, DeleteThreadResponse, DeleteVectorStoreFileResponse, DeleteVectorStoreResponse, DoneEvent, Embedding, Error, ErrorEvent, ErrorResponse, FileSearchRankingOptions, FineTuneChatCompletionRequestAssistantMessage, FineTuneChatRequestInput, FineTuneCompletionRequestInput, FineTuneDPOMethod, FineTuneDPOMethodHyperparameters, FineTuneMethod, FineTunePreferenceRequestInput, FineTunePreferenceRequestInputInput, FineTuneSupervisedMethod, FineTuneSupervisedMethodHyperparameters, FineTuningIntegration, FineTuningJob, FineTuningJobCheckpoint, FineTuningJobCheckpointMetrics, FineTuningJobError, FineTuningJobEvent, FineTuningJobHyperparameters, FunctionObject, Image, ImagesResponse, Invite, InviteDeleteResponse, InviteListResponse, InviteProjectsInner, InviteRequest, InviteRequestProjectsInner, ListAssistantsResponse, ListAuditLogsEffectiveAtParameter, ListAuditLogsResponse, ListBatchesResponse, ListFilesResponse, ListFineTuningJobCheckpointsResponse, ListFineTuningJobEventsResponse, ListMessagesResponse, ListModelsResponse, ListPaginatedFineTuningJobsResponse, ListRunStepsResponse, ListRunsResponse, ListThreadsResponse, ListVectorStoreFilesResponse, ListVectorStoresResponse, MessageContentImageFileObject, MessageContentImageFileObjectImageFile, MessageContentImageUrlObject, MessageContentImageUrlObjectImageUrl, MessageContentRefusalObject, MessageContentTextAnnotationsFileCitationObject, MessageContentTextAnnotationsFileCitationObjectFileCitation, MessageContentTextAnnotationsFilePathObject, MessageContentTextAnnotationsFilePathObjectFilePath, MessageContentTextObject, MessageContentTextObjectText, MessageDeltaContentImageFileObject, MessageDeltaContentImageFileObjectImageFile, MessageDeltaContentImageUrlObject, MessageDeltaContentImageUrlObjectImageUrl, MessageDeltaContentRefusalObject, MessageDeltaContentTextAnnotationsFileCitationObject, MessageDeltaContentTextAnnotationsFileCitationObjectFileCitation, MessageDeltaContentTextAnnotationsFilePathObject, MessageDeltaContentTextAnnotationsFilePathObjectFilePath, MessageDeltaContentTextObject, MessageDeltaContentTextObjectText, MessageDeltaObject, MessageDeltaObjectDelta, MessageObject, MessageObjectIncompleteDetails, MessageRequestContentTextObject, MessageStreamEventOneOf, MessageStreamEventOneOf1, MessageStreamEventOneOf2, MessageStreamEventOneOf3, MessageStreamEventOneOf4, Model, ModifyAssistantRequest, ModifyAssistantRequestToolResources, ModifyAssistantRequestToolResourcesCodeInterpreter, ModifyAssistantRequestToolResourcesFileSearch, ModifyMessageRequest, ModifyRunRequest, ModifyThreadRequest, ModifyThreadRequestToolResources, ModifyThreadRequestToolResourcesFileSearch, OpenAIFile, OtherChunkingStrategyResponseParam, PredictionContent, Project, ProjectApiKey, ProjectApiKeyDeleteResponse, ProjectApiKeyListResponse, ProjectApiKeyOwner, ProjectCreateRequest, ProjectListResponse, ProjectRateLimit, ProjectRateLimitListResponse, ProjectRateLimitUpdateRequest, ProjectServiceAccount, ProjectServiceAccountApiKey, ProjectServiceAccountCreateRequest, ProjectServiceAccountCreateResponse, ProjectServiceAccountDeleteResponse, ProjectServiceAccountListResponse, ProjectUpdateRequest, ProjectUser, ProjectUserCreateRequest, ProjectUserDeleteResponse, ProjectUserListResponse, ProjectUserUpdateRequest, RealtimeClientEventConversationItemCreate, RealtimeClientEventConversationItemDelete, RealtimeClientEventConversationItemTruncate, RealtimeClientEventInputAudioBufferAppend, RealtimeClientEventInputAudioBufferClear, RealtimeClientEventInputAudioBufferCommit, RealtimeClientEventResponseCancel, RealtimeClientEventResponseCreate, RealtimeClientEventSessionUpdate, RealtimeConversationItem, RealtimeConversationItemContentInner, RealtimeResponse, RealtimeResponseCreateParams, RealtimeResponseCreateParamsToolsInner, RealtimeResponseStatusDetails, RealtimeResponseStatusDetailsError, RealtimeResponseUsage, RealtimeResponseUsageInputTokenDetails, RealtimeResponseUsageOutputTokenDetails, RealtimeServerEventConversationCreated, RealtimeServerEventConversationCreatedConversation, RealtimeServerEventConversationItemCreated, RealtimeServerEventConversationItemDeleted, RealtimeServerEventConversationItemInputAudioTranscriptionCompleted, RealtimeServerEventConversationItemInputAudioTranscriptionFailed, RealtimeServerEventConversationItemInputAudioTranscriptionFailedError, RealtimeServerEventConversationItemTruncated, RealtimeServerEventError, RealtimeServerEventErrorError, RealtimeServerEventInputAudioBufferCleared, RealtimeServerEventInputAudioBufferCommitted, RealtimeServerEventInputAudioBufferSpeechStarted, RealtimeServerEventInputAudioBufferSpeechStopped, RealtimeServerEventRateLimitsUpdated, RealtimeServerEventRateLimitsUpdatedRateLimitsInner, RealtimeServerEventResponseAudioDelta, RealtimeServerEventResponseAudioDone, RealtimeServerEventResponseAudioTranscriptDelta, RealtimeServerEventResponseAudioTranscriptDone, RealtimeServerEventResponseContentPartAdded, RealtimeServerEventResponseContentPartAddedPart, RealtimeServerEventResponseContentPartDone, RealtimeServerEventResponseContentPartDonePart, RealtimeServerEventResponseCreated, RealtimeServerEventResponseDone, RealtimeServerEventResponseFunctionCallArgumentsDelta, RealtimeServerEventResponseFunctionCallArgumentsDone, RealtimeServerEventResponseOutputItemAdded, RealtimeServerEventResponseOutputItemDone, RealtimeServerEventResponseTextDelta, RealtimeServerEventResponseTextDone, RealtimeServerEventSessionCreated, RealtimeServerEventSessionUpdated, RealtimeSession, RealtimeSessionCreateRequest, RealtimeSessionCreateRequestTurnDetection, RealtimeSessionCreateResponse, RealtimeSessionCreateResponseClientSecret, RealtimeSessionCreateResponseTurnDetection, RealtimeSessionInputAudioTranscription, RealtimeSessionTurnDetection, ResponseFormatJsonObject, ResponseFormatJsonSchema, ResponseFormatJsonSchemaJsonSchema, ResponseFormatText, RunCompletionUsage, RunObject, RunObjectIncompleteDetails, RunObjectLastError, RunObjectRequiredAction, RunObjectRequiredActionSubmitToolOutputs, RunStepCompletionUsage, RunStepDeltaObject, RunStepDeltaObjectDelta, RunStepDeltaStepDetailsMessageCreationObject, RunStepDeltaStepDetailsMessageCreationObjectMessageCreation, RunStepDeltaStepDetailsToolCallsCodeObject, RunStepDeltaStepDetailsToolCallsCodeObjectCodeInterpreter, RunStepDeltaStepDetailsToolCallsCodeOutputImageObject, RunStepDeltaStepDetailsToolCallsCodeOutputImageObjectImage, RunStepDeltaStepDetailsToolCallsCodeOutputLogsObject, RunStepDeltaStepDetailsToolCallsFileSearchObject, RunStepDeltaStepDetailsToolCallsFunctionObject, RunStepDeltaStepDetailsToolCallsFunctionObjectFunction, RunStepDeltaStepDetailsToolCallsObject, RunStepDetailsMessageCreationObject, RunStepDetailsMessageCreationObjectMessageCreation, RunStepDetailsToolCallsCodeObject, RunStepDetailsToolCallsCodeObjectCodeInterpreter, RunStepDetailsToolCallsCodeOutputImageObject, RunStepDetailsToolCallsCodeOutputImageObjectImage, RunStepDetailsToolCallsCodeOutputLogsObject, RunStepDetailsToolCallsFileSearchObject, RunStepDetailsToolCallsFileSearchObjectFileSearch, RunStepDetailsToolCallsFileSearchRankingOptionsObject, RunStepDetailsToolCallsFileSearchResultObject, RunStepDetailsToolCallsFileSearchResultObjectContentInner, RunStepDetailsToolCallsFunctionObject, RunStepDetailsToolCallsFunctionObjectFunction, RunStepDetailsToolCallsObject, RunStepObject, RunStepObjectLastError, RunStepStreamEventOneOf, RunStepStreamEventOneOf1, RunStepStreamEventOneOf2, RunStepStreamEventOneOf3, RunStepStreamEventOneOf4, RunStepStreamEventOneOf5, RunStepStreamEventOneOf6, RunStreamEventOneOf, RunStreamEventOneOf1, RunStreamEventOneOf2, RunStreamEventOneOf3, RunStreamEventOneOf4, RunStreamEventOneOf5, RunStreamEventOneOf6, RunStreamEventOneOf7, RunStreamEventOneOf8, RunStreamEventOneOf9, RunToolCallObject, RunToolCallObjectFunction, StaticChunkingStrategy, StaticChunkingStrategyRequestParam, StaticChunkingStrategyResponseParam, StaticChunkingStrategyStatic, SubmitToolOutputsRunRequest, SubmitToolOutputsRunRequestToolOutputsInner, ThreadObject, ThreadStreamEvent, TranscriptionSegment, TranscriptionWord, TruncationObject, UpdateVectorStoreRequest, Upload, UploadPart, UsageAudioSpeechesResult, UsageAudioTranscriptionsResult, UsageCodeInterpreterSessionsResult, UsageCompletionsResult, UsageEmbeddingsResult, UsageImagesResult, UsageModerationsResult, UsageResponse, UsageTimeBucket, UsageVectorStoresResult, User, UserDeleteResponse, UserListResponse, UserRoleUpdateRequest, VectorStoreExpirationAfter, VectorStoreFileBatchObject, VectorStoreFileBatchObjectFileCounts, VectorStoreFileObject, VectorStoreFileObjectLastError, VectorStoreObject, VectorStoreObjectFileCounts

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/openapi_openai/api_model_base.rb', line 19

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = OpenApiOpenAIClient.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

Instance Method Details

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/openapi_openai/api_model_base.rb', line 74

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



66
67
68
 
# File 'lib/openapi_openai/api_model_base.rb', line 66

def to_body
  to_hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



60
61
62
 
# File 'lib/openapi_openai/api_model_base.rb', line 60

def to_s
  to_hash.to_s
end