From 16b5638a2763051d36afe5e786c71bd920e1903a Mon Sep 17 00:00:00 2001 From: Ben Date: Mon, 30 Jun 2025 15:27:06 -0400 Subject: [PATCH] add advanced query --- .github/workflows/python.yml | 34 + .gitignore | 85 +- .gitlab-ci.yml | 31 + .openapi-generator-ignore | 23 + .openapi-generator/FILES | 269 ++ .openapi-generator/VERSION | 1 + .travis.yml | 17 + README.md | 219 +- docs/AIPlatform.md | 39 + docs/AIPlatformConfigSchema.md | 34 + docs/AIPlatformSchema.md | 31 + docs/AIPlatformType.md | 18 + docs/AddUserFromSourceConnectorResponse.md | 29 + docs/AddUserToSourceConnectorRequest.md | 31 + ...ourceConnectorRequestSelectedFilesValue.md | 30 + docs/AdvancedQuery.md | 34 + docs/CreateAIPlatformConnector.md | 31 + docs/CreateAIPlatformConnectorResponse.md | 30 + docs/CreateDestinationConnector.md | 31 + docs/CreateDestinationConnectorResponse.md | 30 + docs/CreatePipelineResponse.md | 30 + docs/CreatePipelineResponseData.md | 29 + docs/CreateSourceConnector.md | 31 + docs/CreateSourceConnectorResponse.md | 30 + docs/CreatedAIPlatformConnector.md | 30 + docs/CreatedDestinationConnector.md | 30 + docs/CreatedSourceConnector.md | 30 + docs/DeepResearchResult.md | 32 + docs/DeleteAIPlatformConnectorResponse.md | 29 + docs/DeleteDestinationConnectorResponse.md | 29 + docs/DeleteFileResponse.md | 30 + docs/DeletePipelineResponse.md | 29 + docs/DeleteSourceConnectorResponse.md | 29 + docs/DestinationConnector.md | 39 + docs/DestinationConnectorSchema.md | 31 + docs/DestinationConnectorType.md | 36 + docs/Document.md | 41 + docs/ExtractionChunkingStrategy.md | 10 + docs/ExtractionResult.md | 36 + docs/ExtractionResultResponse.md | 30 + docs/ExtractionType.md | 10 + docs/GetDeepResearchResponse.md | 30 + docs/GetPipelineEventsResponse.md | 31 + docs/GetPipelineMetricsResponse.md | 30 + docs/GetPipelineResponse.md | 30 + docs/GetPipelines400Response.md | 32 + docs/GetPipelinesResponse.md | 30 + docs/GetUploadFilesResponse.md | 30 + docs/MetadataExtractionStrategy.md | 30 + docs/MetadataExtractionStrategySchema.md | 30 + docs/N8NConfig.md | 31 + docs/PipelineConfigurationSchema.md | 33 + docs/PipelineEvents.md | 33 + docs/PipelineListSummary.md | 41 + docs/PipelineMetrics.md | 32 + docs/PipelineSummary.md | 44 + docs/PipelinesApi.md | 175 ++ docs/RemoveUserFromSourceConnectorRequest.md | 29 + docs/RemoveUserFromSourceConnectorResponse.md | 29 + docs/RetrieveContext.md | 29 + docs/RetrieveContextMessage.md | 30 + docs/RetrieveDocumentsRequest.md | 34 + docs/RetrieveDocumentsResponse.md | 32 + docs/ScheduleSchema.md | 29 + docs/ScheduleSchemaType.md | 14 + docs/SourceConnector.md | 39 + docs/SourceConnectorSchema.md | 31 + docs/SourceConnectorType.md | 44 + docs/StartDeepResearchRequest.md | 32 + docs/StartDeepResearchResponse.md | 29 + docs/StartExtractionRequest.md | 33 + docs/StartExtractionResponse.md | 30 + docs/StartFileUploadRequest.md | 30 + docs/StartFileUploadResponse.md | 30 + docs/StartFileUploadToConnectorRequest.md | 31 + docs/StartFileUploadToConnectorResponse.md | 29 + docs/StartPipelineResponse.md | 29 + docs/StopPipelineResponse.md | 29 + docs/UpdateAIPlatformConnectorRequest.md | 29 + docs/UpdateAIPlatformConnectorResponse.md | 30 + docs/UpdateDestinationConnectorRequest.md | 29 + docs/UpdateDestinationConnectorResponse.md | 30 + docs/UpdateSourceConnectorRequest.md | 29 + docs/UpdateSourceConnectorResponse.md | 30 + docs/UpdateSourceConnectorResponseData.md | 30 + docs/UpdateUserInSourceConnectorRequest.md | 31 + docs/UpdateUserInSourceConnectorResponse.md | 29 + docs/UpdatedAIPlatformConnectorData.md | 30 + docs/UpdatedDestinationConnectorData.md | 30 + docs/UploadFile.md | 34 + git_push.sh | 57 + openapi.json | 2197 +++++++++++++++++ openapitools.json | 7 + pyproject.toml | 95 + requirements.txt | 4 + setup.cfg | 2 + setup.py | 49 + test-requirements.txt | 6 + test/__init__.py | 0 ...add_user_from_source_connector_response.py | 52 + ...st_add_user_to_source_connector_request.py | 64 + ..._connector_request_selected_files_value.py | 54 + test/test_advanced_query.py | 57 + test/test_ai_platform.py | 66 + test/test_ai_platform_config_schema.py | 56 + test/test_ai_platform_schema.py | 68 + test/test_ai_platform_type.py | 33 + test/test_create_ai_platform_connector.py | 57 + ...t_create_ai_platform_connector_response.py | 62 + test/test_create_destination_connector.py | 57 + ...t_create_destination_connector_response.py | 62 + test/test_create_pipeline_response.py | 56 + test/test_create_pipeline_response_data.py | 52 + test/test_create_source_connector.py | 57 + test/test_create_source_connector_response.py | 62 + test/test_created_ai_platform_connector.py | 54 + test/test_created_destination_connector.py | 54 + test/test_created_source_connector.py | 54 + test/test_deep_research_result.py | 57 + ...t_delete_ai_platform_connector_response.py | 52 + ...t_delete_destination_connector_response.py | 52 + test/test_delete_file_response.py | 54 + test/test_delete_pipeline_response.py | 52 + test/test_delete_source_connector_response.py | 52 + test/test_destination_connector.py | 66 + test/test_destination_connector_schema.py | 57 + test/test_destination_connector_type.py | 33 + test/test_document.py | 74 + test/test_extraction_chunking_strategy.py | 33 + test/test_extraction_result.py | 65 + test/test_extraction_result_response.py | 67 + test/test_extraction_type.py | 33 + test/test_get_deep_research_response.py | 59 + test/test_get_pipeline_events_response.py | 77 + test/test_get_pipeline_metrics_response.py | 66 + test/test_get_pipeline_response.py | 186 ++ test/test_get_pipelines400_response.py | 59 + test/test_get_pipelines_response.py | 112 + test/test_get_upload_files_response.py | 74 + test/test_metadata_extraction_strategy.py | 56 + ...est_metadata_extraction_strategy_schema.py | 54 + test/test_n8_n_config.py | 57 + test/test_pipeline_configuration_schema.py | 104 + test/test_pipeline_events.py | 62 + test/test_pipeline_list_summary.py | 100 + test/test_pipeline_metrics.py | 58 + test/test_pipeline_summary.py | 196 ++ test/test_pipelines_api.py | 45 + ...move_user_from_source_connector_request.py | 52 + ...ove_user_from_source_connector_response.py | 52 + test/test_retrieve_context.py | 60 + test/test_retrieve_context_message.py | 54 + test/test_retrieve_documents_request.py | 74 + test/test_retrieve_documents_response.py | 62 + test/test_schedule_schema.py | 52 + test/test_schedule_schema_type.py | 33 + test/test_source_connector.py | 66 + test/test_source_connector_schema.py | 57 + test/test_source_connector_type.py | 33 + test/test_start_deep_research_request.py | 60 + test/test_start_deep_research_response.py | 52 + test/test_start_extraction_request.py | 62 + test/test_start_extraction_response.py | 54 + test/test_start_file_upload_request.py | 54 + test/test_start_file_upload_response.py | 54 + ..._start_file_upload_to_connector_request.py | 55 + ...start_file_upload_to_connector_response.py | 52 + test/test_start_pipeline_response.py | 52 + test/test_stop_pipeline_response.py | 52 + ...st_update_ai_platform_connector_request.py | 56 + ...t_update_ai_platform_connector_response.py | 88 + ...st_update_destination_connector_request.py | 56 + ...t_update_destination_connector_response.py | 88 + test/test_update_source_connector_request.py | 56 + test/test_update_source_connector_response.py | 88 + ...t_update_source_connector_response_data.py | 81 + ...update_user_in_source_connector_request.py | 58 + ...pdate_user_in_source_connector_response.py | 52 + ...test_updated_ai_platform_connector_data.py | 81 + ...test_updated_destination_connector_data.py | 81 + test/test_upload_file.py | 65 + tox.ini | 9 + vectorize_client/__init__.py | 209 ++ vectorize_client/api/__init__.py | 5 + vectorize_client/api/pipelines_api.py | 613 +++++ vectorize_client/api_client.py | 801 ++++++ vectorize_client/api_response.py | 21 + vectorize_client/configuration.py | 582 +++++ vectorize_client/exceptions.py | 216 ++ vectorize_client/models/__init__.py | 97 + ...add_user_from_source_connector_response.py | 87 + .../add_user_to_source_connector_request.py | 104 + ..._connector_request_selected_files_value.py | 89 + vectorize_client/models/advanced_query.py | 115 + vectorize_client/models/ai_platform.py | 112 + .../models/ai_platform_config_schema.py | 128 + vectorize_client/models/ai_platform_schema.py | 96 + vectorize_client/models/ai_platform_type.py | 40 + .../models/create_ai_platform_connector.py | 92 + .../create_ai_platform_connector_response.py | 97 + .../models/create_destination_connector.py | 92 + .../create_destination_connector_response.py | 97 + .../models/create_pipeline_response.py | 93 + .../models/create_pipeline_response_data.py | 87 + .../models/create_source_connector.py | 92 + .../create_source_connector_response.py | 97 + .../models/created_ai_platform_connector.py | 89 + .../models/created_destination_connector.py | 89 + .../models/created_source_connector.py | 89 + .../models/deep_research_result.py | 93 + .../delete_ai_platform_connector_response.py | 87 + .../delete_destination_connector_response.py | 87 + .../models/delete_file_response.py | 89 + .../models/delete_pipeline_response.py | 87 + .../delete_source_connector_response.py | 87 + .../models/destination_connector.py | 112 + .../models/destination_connector_schema.py | 92 + .../models/destination_connector_type.py | 49 + vectorize_client/models/document.py | 124 + .../models/extraction_chunking_strategy.py | 36 + vectorize_client/models/extraction_result.py | 101 + .../models/extraction_result_response.py | 93 + vectorize_client/models/extraction_type.py | 36 + .../models/get_deep_research_response.py | 93 + .../models/get_pipeline_events_response.py | 99 + .../models/get_pipeline_metrics_response.py | 97 + .../models/get_pipeline_response.py | 93 + .../models/get_pipelines400_response.py | 93 + .../models/get_pipelines_response.py | 97 + .../models/get_upload_files_response.py | 97 + .../models/metadata_extraction_strategy.py | 97 + .../metadata_extraction_strategy_schema.py | 89 + vectorize_client/models/n8_n_config.py | 91 + .../models/pipeline_configuration_schema.py | 116 + vectorize_client/models/pipeline_events.py | 100 + .../models/pipeline_list_summary.py | 116 + vectorize_client/models/pipeline_metrics.py | 98 + vectorize_client/models/pipeline_summary.py | 146 ++ ...move_user_from_source_connector_request.py | 87 + ...ove_user_from_source_connector_response.py | 87 + vectorize_client/models/retrieve_context.py | 95 + .../models/retrieve_context_message.py | 89 + .../models/retrieve_documents_request.py | 106 + .../models/retrieve_documents_response.py | 101 + vectorize_client/models/schedule_schema.py | 88 + .../models/schedule_schema_type.py | 38 + vectorize_client/models/source_connector.py | 112 + .../models/source_connector_schema.py | 92 + .../models/source_connector_type.py | 53 + .../models/start_deep_research_request.py | 97 + .../models/start_deep_research_response.py | 87 + .../models/start_extraction_request.py | 101 + .../models/start_extraction_response.py | 89 + .../models/start_file_upload_request.py | 89 + .../models/start_file_upload_response.py | 89 + .../start_file_upload_to_connector_request.py | 91 + ...start_file_upload_to_connector_response.py | 87 + .../models/start_pipeline_response.py | 87 + .../models/stop_pipeline_response.py | 87 + .../update_ai_platform_connector_request.py | 87 + .../update_ai_platform_connector_response.py | 93 + .../update_destination_connector_request.py | 87 + .../update_destination_connector_response.py | 93 + .../models/update_source_connector_request.py | 87 + .../update_source_connector_response.py | 93 + .../update_source_connector_response_data.py | 93 + ...update_user_in_source_connector_request.py | 104 + ...pdate_user_in_source_connector_response.py | 87 + .../updated_ai_platform_connector_data.py | 93 + .../updated_destination_connector_data.py | 93 + vectorize_client/models/upload_file.py | 102 + vectorize_client/py.typed | 0 vectorize_client/rest.py | 258 ++ 273 files changed, 21133 insertions(+), 53 deletions(-) create mode 100644 .github/workflows/python.yml create mode 100644 .gitlab-ci.yml create mode 100644 .openapi-generator-ignore create mode 100644 .openapi-generator/FILES create mode 100644 .openapi-generator/VERSION create mode 100644 .travis.yml create mode 100644 docs/AIPlatform.md create mode 100644 docs/AIPlatformConfigSchema.md create mode 100644 docs/AIPlatformSchema.md create mode 100644 docs/AIPlatformType.md create mode 100644 docs/AddUserFromSourceConnectorResponse.md create mode 100644 docs/AddUserToSourceConnectorRequest.md create mode 100644 docs/AddUserToSourceConnectorRequestSelectedFilesValue.md create mode 100644 docs/AdvancedQuery.md create mode 100644 docs/CreateAIPlatformConnector.md create mode 100644 docs/CreateAIPlatformConnectorResponse.md create mode 100644 docs/CreateDestinationConnector.md create mode 100644 docs/CreateDestinationConnectorResponse.md create mode 100644 docs/CreatePipelineResponse.md create mode 100644 docs/CreatePipelineResponseData.md create mode 100644 docs/CreateSourceConnector.md create mode 100644 docs/CreateSourceConnectorResponse.md create mode 100644 docs/CreatedAIPlatformConnector.md create mode 100644 docs/CreatedDestinationConnector.md create mode 100644 docs/CreatedSourceConnector.md create mode 100644 docs/DeepResearchResult.md create mode 100644 docs/DeleteAIPlatformConnectorResponse.md create mode 100644 docs/DeleteDestinationConnectorResponse.md create mode 100644 docs/DeleteFileResponse.md create mode 100644 docs/DeletePipelineResponse.md create mode 100644 docs/DeleteSourceConnectorResponse.md create mode 100644 docs/DestinationConnector.md create mode 100644 docs/DestinationConnectorSchema.md create mode 100644 docs/DestinationConnectorType.md create mode 100644 docs/Document.md create mode 100644 docs/ExtractionChunkingStrategy.md create mode 100644 docs/ExtractionResult.md create mode 100644 docs/ExtractionResultResponse.md create mode 100644 docs/ExtractionType.md create mode 100644 docs/GetDeepResearchResponse.md create mode 100644 docs/GetPipelineEventsResponse.md create mode 100644 docs/GetPipelineMetricsResponse.md create mode 100644 docs/GetPipelineResponse.md create mode 100644 docs/GetPipelines400Response.md create mode 100644 docs/GetPipelinesResponse.md create mode 100644 docs/GetUploadFilesResponse.md create mode 100644 docs/MetadataExtractionStrategy.md create mode 100644 docs/MetadataExtractionStrategySchema.md create mode 100644 docs/N8NConfig.md create mode 100644 docs/PipelineConfigurationSchema.md create mode 100644 docs/PipelineEvents.md create mode 100644 docs/PipelineListSummary.md create mode 100644 docs/PipelineMetrics.md create mode 100644 docs/PipelineSummary.md create mode 100644 docs/PipelinesApi.md create mode 100644 docs/RemoveUserFromSourceConnectorRequest.md create mode 100644 docs/RemoveUserFromSourceConnectorResponse.md create mode 100644 docs/RetrieveContext.md create mode 100644 docs/RetrieveContextMessage.md create mode 100644 docs/RetrieveDocumentsRequest.md create mode 100644 docs/RetrieveDocumentsResponse.md create mode 100644 docs/ScheduleSchema.md create mode 100644 docs/ScheduleSchemaType.md create mode 100644 docs/SourceConnector.md create mode 100644 docs/SourceConnectorSchema.md create mode 100644 docs/SourceConnectorType.md create mode 100644 docs/StartDeepResearchRequest.md create mode 100644 docs/StartDeepResearchResponse.md create mode 100644 docs/StartExtractionRequest.md create mode 100644 docs/StartExtractionResponse.md create mode 100644 docs/StartFileUploadRequest.md create mode 100644 docs/StartFileUploadResponse.md create mode 100644 docs/StartFileUploadToConnectorRequest.md create mode 100644 docs/StartFileUploadToConnectorResponse.md create mode 100644 docs/StartPipelineResponse.md create mode 100644 docs/StopPipelineResponse.md create mode 100644 docs/UpdateAIPlatformConnectorRequest.md create mode 100644 docs/UpdateAIPlatformConnectorResponse.md create mode 100644 docs/UpdateDestinationConnectorRequest.md create mode 100644 docs/UpdateDestinationConnectorResponse.md create mode 100644 docs/UpdateSourceConnectorRequest.md create mode 100644 docs/UpdateSourceConnectorResponse.md create mode 100644 docs/UpdateSourceConnectorResponseData.md create mode 100644 docs/UpdateUserInSourceConnectorRequest.md create mode 100644 docs/UpdateUserInSourceConnectorResponse.md create mode 100644 docs/UpdatedAIPlatformConnectorData.md create mode 100644 docs/UpdatedDestinationConnectorData.md create mode 100644 docs/UploadFile.md create mode 100644 git_push.sh create mode 100644 openapi.json create mode 100644 openapitools.json create mode 100644 pyproject.toml create mode 100644 requirements.txt create mode 100644 setup.cfg create mode 100644 setup.py create mode 100644 test-requirements.txt create mode 100644 test/__init__.py create mode 100644 test/test_add_user_from_source_connector_response.py create mode 100644 test/test_add_user_to_source_connector_request.py create mode 100644 test/test_add_user_to_source_connector_request_selected_files_value.py create mode 100644 test/test_advanced_query.py create mode 100644 test/test_ai_platform.py create mode 100644 test/test_ai_platform_config_schema.py create mode 100644 test/test_ai_platform_schema.py create mode 100644 test/test_ai_platform_type.py create mode 100644 test/test_create_ai_platform_connector.py create mode 100644 test/test_create_ai_platform_connector_response.py create mode 100644 test/test_create_destination_connector.py create mode 100644 test/test_create_destination_connector_response.py create mode 100644 test/test_create_pipeline_response.py create mode 100644 test/test_create_pipeline_response_data.py create mode 100644 test/test_create_source_connector.py create mode 100644 test/test_create_source_connector_response.py create mode 100644 test/test_created_ai_platform_connector.py create mode 100644 test/test_created_destination_connector.py create mode 100644 test/test_created_source_connector.py create mode 100644 test/test_deep_research_result.py create mode 100644 test/test_delete_ai_platform_connector_response.py create mode 100644 test/test_delete_destination_connector_response.py create mode 100644 test/test_delete_file_response.py create mode 100644 test/test_delete_pipeline_response.py create mode 100644 test/test_delete_source_connector_response.py create mode 100644 test/test_destination_connector.py create mode 100644 test/test_destination_connector_schema.py create mode 100644 test/test_destination_connector_type.py create mode 100644 test/test_document.py create mode 100644 test/test_extraction_chunking_strategy.py create mode 100644 test/test_extraction_result.py create mode 100644 test/test_extraction_result_response.py create mode 100644 test/test_extraction_type.py create mode 100644 test/test_get_deep_research_response.py create mode 100644 test/test_get_pipeline_events_response.py create mode 100644 test/test_get_pipeline_metrics_response.py create mode 100644 test/test_get_pipeline_response.py create mode 100644 test/test_get_pipelines400_response.py create mode 100644 test/test_get_pipelines_response.py create mode 100644 test/test_get_upload_files_response.py create mode 100644 test/test_metadata_extraction_strategy.py create mode 100644 test/test_metadata_extraction_strategy_schema.py create mode 100644 test/test_n8_n_config.py create mode 100644 test/test_pipeline_configuration_schema.py create mode 100644 test/test_pipeline_events.py create mode 100644 test/test_pipeline_list_summary.py create mode 100644 test/test_pipeline_metrics.py create mode 100644 test/test_pipeline_summary.py create mode 100644 test/test_pipelines_api.py create mode 100644 test/test_remove_user_from_source_connector_request.py create mode 100644 test/test_remove_user_from_source_connector_response.py create mode 100644 test/test_retrieve_context.py create mode 100644 test/test_retrieve_context_message.py create mode 100644 test/test_retrieve_documents_request.py create mode 100644 test/test_retrieve_documents_response.py create mode 100644 test/test_schedule_schema.py create mode 100644 test/test_schedule_schema_type.py create mode 100644 test/test_source_connector.py create mode 100644 test/test_source_connector_schema.py create mode 100644 test/test_source_connector_type.py create mode 100644 test/test_start_deep_research_request.py create mode 100644 test/test_start_deep_research_response.py create mode 100644 test/test_start_extraction_request.py create mode 100644 test/test_start_extraction_response.py create mode 100644 test/test_start_file_upload_request.py create mode 100644 test/test_start_file_upload_response.py create mode 100644 test/test_start_file_upload_to_connector_request.py create mode 100644 test/test_start_file_upload_to_connector_response.py create mode 100644 test/test_start_pipeline_response.py create mode 100644 test/test_stop_pipeline_response.py create mode 100644 test/test_update_ai_platform_connector_request.py create mode 100644 test/test_update_ai_platform_connector_response.py create mode 100644 test/test_update_destination_connector_request.py create mode 100644 test/test_update_destination_connector_response.py create mode 100644 test/test_update_source_connector_request.py create mode 100644 test/test_update_source_connector_response.py create mode 100644 test/test_update_source_connector_response_data.py create mode 100644 test/test_update_user_in_source_connector_request.py create mode 100644 test/test_update_user_in_source_connector_response.py create mode 100644 test/test_updated_ai_platform_connector_data.py create mode 100644 test/test_updated_destination_connector_data.py create mode 100644 test/test_upload_file.py create mode 100644 tox.ini create mode 100644 vectorize_client/__init__.py create mode 100644 vectorize_client/api/__init__.py create mode 100644 vectorize_client/api/pipelines_api.py create mode 100644 vectorize_client/api_client.py create mode 100644 vectorize_client/api_response.py create mode 100644 vectorize_client/configuration.py create mode 100644 vectorize_client/exceptions.py create mode 100644 vectorize_client/models/__init__.py create mode 100644 vectorize_client/models/add_user_from_source_connector_response.py create mode 100644 vectorize_client/models/add_user_to_source_connector_request.py create mode 100644 vectorize_client/models/add_user_to_source_connector_request_selected_files_value.py create mode 100644 vectorize_client/models/advanced_query.py create mode 100644 vectorize_client/models/ai_platform.py create mode 100644 vectorize_client/models/ai_platform_config_schema.py create mode 100644 vectorize_client/models/ai_platform_schema.py create mode 100644 vectorize_client/models/ai_platform_type.py create mode 100644 vectorize_client/models/create_ai_platform_connector.py create mode 100644 vectorize_client/models/create_ai_platform_connector_response.py create mode 100644 vectorize_client/models/create_destination_connector.py create mode 100644 vectorize_client/models/create_destination_connector_response.py create mode 100644 vectorize_client/models/create_pipeline_response.py create mode 100644 vectorize_client/models/create_pipeline_response_data.py create mode 100644 vectorize_client/models/create_source_connector.py create mode 100644 vectorize_client/models/create_source_connector_response.py create mode 100644 vectorize_client/models/created_ai_platform_connector.py create mode 100644 vectorize_client/models/created_destination_connector.py create mode 100644 vectorize_client/models/created_source_connector.py create mode 100644 vectorize_client/models/deep_research_result.py create mode 100644 vectorize_client/models/delete_ai_platform_connector_response.py create mode 100644 vectorize_client/models/delete_destination_connector_response.py create mode 100644 vectorize_client/models/delete_file_response.py create mode 100644 vectorize_client/models/delete_pipeline_response.py create mode 100644 vectorize_client/models/delete_source_connector_response.py create mode 100644 vectorize_client/models/destination_connector.py create mode 100644 vectorize_client/models/destination_connector_schema.py create mode 100644 vectorize_client/models/destination_connector_type.py create mode 100644 vectorize_client/models/document.py create mode 100644 vectorize_client/models/extraction_chunking_strategy.py create mode 100644 vectorize_client/models/extraction_result.py create mode 100644 vectorize_client/models/extraction_result_response.py create mode 100644 vectorize_client/models/extraction_type.py create mode 100644 vectorize_client/models/get_deep_research_response.py create mode 100644 vectorize_client/models/get_pipeline_events_response.py create mode 100644 vectorize_client/models/get_pipeline_metrics_response.py create mode 100644 vectorize_client/models/get_pipeline_response.py create mode 100644 vectorize_client/models/get_pipelines400_response.py create mode 100644 vectorize_client/models/get_pipelines_response.py create mode 100644 vectorize_client/models/get_upload_files_response.py create mode 100644 vectorize_client/models/metadata_extraction_strategy.py create mode 100644 vectorize_client/models/metadata_extraction_strategy_schema.py create mode 100644 vectorize_client/models/n8_n_config.py create mode 100644 vectorize_client/models/pipeline_configuration_schema.py create mode 100644 vectorize_client/models/pipeline_events.py create mode 100644 vectorize_client/models/pipeline_list_summary.py create mode 100644 vectorize_client/models/pipeline_metrics.py create mode 100644 vectorize_client/models/pipeline_summary.py create mode 100644 vectorize_client/models/remove_user_from_source_connector_request.py create mode 100644 vectorize_client/models/remove_user_from_source_connector_response.py create mode 100644 vectorize_client/models/retrieve_context.py create mode 100644 vectorize_client/models/retrieve_context_message.py create mode 100644 vectorize_client/models/retrieve_documents_request.py create mode 100644 vectorize_client/models/retrieve_documents_response.py create mode 100644 vectorize_client/models/schedule_schema.py create mode 100644 vectorize_client/models/schedule_schema_type.py create mode 100644 vectorize_client/models/source_connector.py create mode 100644 vectorize_client/models/source_connector_schema.py create mode 100644 vectorize_client/models/source_connector_type.py create mode 100644 vectorize_client/models/start_deep_research_request.py create mode 100644 vectorize_client/models/start_deep_research_response.py create mode 100644 vectorize_client/models/start_extraction_request.py create mode 100644 vectorize_client/models/start_extraction_response.py create mode 100644 vectorize_client/models/start_file_upload_request.py create mode 100644 vectorize_client/models/start_file_upload_response.py create mode 100644 vectorize_client/models/start_file_upload_to_connector_request.py create mode 100644 vectorize_client/models/start_file_upload_to_connector_response.py create mode 100644 vectorize_client/models/start_pipeline_response.py create mode 100644 vectorize_client/models/stop_pipeline_response.py create mode 100644 vectorize_client/models/update_ai_platform_connector_request.py create mode 100644 vectorize_client/models/update_ai_platform_connector_response.py create mode 100644 vectorize_client/models/update_destination_connector_request.py create mode 100644 vectorize_client/models/update_destination_connector_response.py create mode 100644 vectorize_client/models/update_source_connector_request.py create mode 100644 vectorize_client/models/update_source_connector_response.py create mode 100644 vectorize_client/models/update_source_connector_response_data.py create mode 100644 vectorize_client/models/update_user_in_source_connector_request.py create mode 100644 vectorize_client/models/update_user_in_source_connector_response.py create mode 100644 vectorize_client/models/updated_ai_platform_connector_data.py create mode 100644 vectorize_client/models/updated_destination_connector_data.py create mode 100644 vectorize_client/models/upload_file.py create mode 100644 vectorize_client/py.typed create mode 100644 vectorize_client/rest.py diff --git a/.github/workflows/python.yml b/.github/workflows/python.yml new file mode 100644 index 0000000..683224b --- /dev/null +++ b/.github/workflows/python.yml @@ -0,0 +1,34 @@ +# NOTE: This file is auto generated by OpenAPI Generator. +# URL: https://openapi-generator.tech +# +# ref: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python + +name: vectorize_client Python package + +on: [push, pull_request] + +permissions: + contents: read + +jobs: + build: + + runs-on: ubuntu-latest + strategy: + matrix: + python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"] + + steps: + - uses: actions/checkout@v4 + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v4 + with: + python-version: ${{ matrix.python-version }} + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install -r requirements.txt + pip install -r test-requirements.txt + - name: Test with pytest + run: | + pytest --cov=vectorize_client diff --git a/.gitignore b/.gitignore index a7d8464..43995bd 100644 --- a/.gitignore +++ b/.gitignore @@ -1,19 +1,66 @@ -openapitools.json -src/**/.openapi-generator-ignore -src/**/.openapi-generator -src/**/.github -src/**/test -src/**/.gitlab-ci.yml -src/**/.travis.yml -src/**/git_push.sh -src/**/requirements.txt -src/**/setup.py -src/**/setup.cfg -src/**/test-requirements.txt -src/**/tox.ini -src/**/docs -node_modules - -**/*.pyc -.idea -gen-docs \ No newline at end of file +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +env/ +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +*.egg-info/ +.installed.cfg +*.egg + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*,cover +.hypothesis/ +venv/ +.venv/ +.python-version +.pytest_cache + +# Translations +*.mo +*.pot + +# Django stuff: +*.log + +# Sphinx documentation +docs/_build/ + +# PyBuilder +target/ + +#Ipython Notebook +.ipynb_checkpoints diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml new file mode 100644 index 0000000..1a64f7c --- /dev/null +++ b/.gitlab-ci.yml @@ -0,0 +1,31 @@ +# NOTE: This file is auto generated by OpenAPI Generator. +# URL: https://openapi-generator.tech +# +# ref: https://docs.gitlab.com/ee/ci/README.html +# ref: https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/gitlab/ci/templates/Python.gitlab-ci.yml + +stages: + - test + +.pytest: + stage: test + script: + - pip install -r requirements.txt + - pip install -r test-requirements.txt + - pytest --cov=vectorize_client + +pytest-3.9: + extends: .pytest + image: python:3.9-alpine +pytest-3.10: + extends: .pytest + image: python:3.10-alpine +pytest-3.11: + extends: .pytest + image: python:3.11-alpine +pytest-3.12: + extends: .pytest + image: python:3.12-alpine +pytest-3.13: + extends: .pytest + image: python:3.13-alpine diff --git a/.openapi-generator-ignore b/.openapi-generator-ignore new file mode 100644 index 0000000..7484ee5 --- /dev/null +++ b/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES new file mode 100644 index 0000000..4c6532e --- /dev/null +++ b/.openapi-generator/FILES @@ -0,0 +1,269 @@ +.github/workflows/python.yml +.gitignore +.gitlab-ci.yml +.openapi-generator-ignore +.travis.yml +README.md +docs/AIPlatform.md +docs/AIPlatformConfigSchema.md +docs/AIPlatformSchema.md +docs/AIPlatformType.md +docs/AddUserFromSourceConnectorResponse.md +docs/AddUserToSourceConnectorRequest.md +docs/AddUserToSourceConnectorRequestSelectedFilesValue.md +docs/AdvancedQuery.md +docs/CreateAIPlatformConnector.md +docs/CreateAIPlatformConnectorResponse.md +docs/CreateDestinationConnector.md +docs/CreateDestinationConnectorResponse.md +docs/CreatePipelineResponse.md +docs/CreatePipelineResponseData.md +docs/CreateSourceConnector.md +docs/CreateSourceConnectorResponse.md +docs/CreatedAIPlatformConnector.md +docs/CreatedDestinationConnector.md +docs/CreatedSourceConnector.md +docs/DeepResearchResult.md +docs/DeleteAIPlatformConnectorResponse.md +docs/DeleteDestinationConnectorResponse.md +docs/DeleteFileResponse.md +docs/DeletePipelineResponse.md +docs/DeleteSourceConnectorResponse.md +docs/DestinationConnector.md +docs/DestinationConnectorSchema.md +docs/DestinationConnectorType.md +docs/Document.md +docs/ExtractionChunkingStrategy.md +docs/ExtractionResult.md +docs/ExtractionResultResponse.md +docs/ExtractionType.md +docs/GetDeepResearchResponse.md +docs/GetPipelineEventsResponse.md +docs/GetPipelineMetricsResponse.md +docs/GetPipelineResponse.md +docs/GetPipelines400Response.md +docs/GetPipelinesResponse.md +docs/GetUploadFilesResponse.md +docs/MetadataExtractionStrategy.md +docs/MetadataExtractionStrategySchema.md +docs/N8NConfig.md +docs/PipelineConfigurationSchema.md +docs/PipelineEvents.md +docs/PipelineListSummary.md +docs/PipelineMetrics.md +docs/PipelineSummary.md +docs/PipelinesApi.md +docs/RemoveUserFromSourceConnectorRequest.md +docs/RemoveUserFromSourceConnectorResponse.md +docs/RetrieveContext.md +docs/RetrieveContextMessage.md +docs/RetrieveDocumentsRequest.md +docs/RetrieveDocumentsResponse.md +docs/ScheduleSchema.md +docs/ScheduleSchemaType.md +docs/SourceConnector.md +docs/SourceConnectorSchema.md +docs/SourceConnectorType.md +docs/StartDeepResearchRequest.md +docs/StartDeepResearchResponse.md +docs/StartExtractionRequest.md +docs/StartExtractionResponse.md +docs/StartFileUploadRequest.md +docs/StartFileUploadResponse.md +docs/StartFileUploadToConnectorRequest.md +docs/StartFileUploadToConnectorResponse.md +docs/StartPipelineResponse.md +docs/StopPipelineResponse.md +docs/UpdateAIPlatformConnectorRequest.md +docs/UpdateAIPlatformConnectorResponse.md +docs/UpdateDestinationConnectorRequest.md +docs/UpdateDestinationConnectorResponse.md +docs/UpdateSourceConnectorRequest.md +docs/UpdateSourceConnectorResponse.md +docs/UpdateSourceConnectorResponseData.md +docs/UpdateUserInSourceConnectorRequest.md +docs/UpdateUserInSourceConnectorResponse.md +docs/UpdatedAIPlatformConnectorData.md +docs/UpdatedDestinationConnectorData.md +docs/UploadFile.md +git_push.sh +pyproject.toml +requirements.txt +setup.cfg +setup.py +test-requirements.txt +test/__init__.py +test/test_add_user_from_source_connector_response.py +test/test_add_user_to_source_connector_request.py +test/test_add_user_to_source_connector_request_selected_files_value.py +test/test_advanced_query.py +test/test_ai_platform.py +test/test_ai_platform_config_schema.py +test/test_ai_platform_schema.py +test/test_ai_platform_type.py +test/test_create_ai_platform_connector.py +test/test_create_ai_platform_connector_response.py +test/test_create_destination_connector.py +test/test_create_destination_connector_response.py +test/test_create_pipeline_response.py +test/test_create_pipeline_response_data.py +test/test_create_source_connector.py +test/test_create_source_connector_response.py +test/test_created_ai_platform_connector.py +test/test_created_destination_connector.py +test/test_created_source_connector.py +test/test_deep_research_result.py +test/test_delete_ai_platform_connector_response.py +test/test_delete_destination_connector_response.py +test/test_delete_file_response.py +test/test_delete_pipeline_response.py +test/test_delete_source_connector_response.py +test/test_destination_connector.py +test/test_destination_connector_schema.py +test/test_destination_connector_type.py +test/test_document.py +test/test_extraction_chunking_strategy.py +test/test_extraction_result.py +test/test_extraction_result_response.py +test/test_extraction_type.py +test/test_get_deep_research_response.py +test/test_get_pipeline_events_response.py +test/test_get_pipeline_metrics_response.py +test/test_get_pipeline_response.py +test/test_get_pipelines400_response.py +test/test_get_pipelines_response.py +test/test_get_upload_files_response.py +test/test_metadata_extraction_strategy.py +test/test_metadata_extraction_strategy_schema.py +test/test_n8_n_config.py +test/test_pipeline_configuration_schema.py +test/test_pipeline_events.py +test/test_pipeline_list_summary.py +test/test_pipeline_metrics.py +test/test_pipeline_summary.py +test/test_pipelines_api.py +test/test_remove_user_from_source_connector_request.py +test/test_remove_user_from_source_connector_response.py +test/test_retrieve_context.py +test/test_retrieve_context_message.py +test/test_retrieve_documents_request.py +test/test_retrieve_documents_response.py +test/test_schedule_schema.py +test/test_schedule_schema_type.py +test/test_source_connector.py +test/test_source_connector_schema.py +test/test_source_connector_type.py +test/test_start_deep_research_request.py +test/test_start_deep_research_response.py +test/test_start_extraction_request.py +test/test_start_extraction_response.py +test/test_start_file_upload_request.py +test/test_start_file_upload_response.py +test/test_start_file_upload_to_connector_request.py +test/test_start_file_upload_to_connector_response.py +test/test_start_pipeline_response.py +test/test_stop_pipeline_response.py +test/test_update_ai_platform_connector_request.py +test/test_update_ai_platform_connector_response.py +test/test_update_destination_connector_request.py +test/test_update_destination_connector_response.py +test/test_update_source_connector_request.py +test/test_update_source_connector_response.py +test/test_update_source_connector_response_data.py +test/test_update_user_in_source_connector_request.py +test/test_update_user_in_source_connector_response.py +test/test_updated_ai_platform_connector_data.py +test/test_updated_destination_connector_data.py +test/test_upload_file.py +tox.ini +vectorize_client/__init__.py +vectorize_client/api/__init__.py +vectorize_client/api/pipelines_api.py +vectorize_client/api_client.py +vectorize_client/api_response.py +vectorize_client/configuration.py +vectorize_client/exceptions.py +vectorize_client/models/__init__.py +vectorize_client/models/add_user_from_source_connector_response.py +vectorize_client/models/add_user_to_source_connector_request.py +vectorize_client/models/add_user_to_source_connector_request_selected_files_value.py +vectorize_client/models/advanced_query.py +vectorize_client/models/ai_platform.py +vectorize_client/models/ai_platform_config_schema.py +vectorize_client/models/ai_platform_schema.py +vectorize_client/models/ai_platform_type.py +vectorize_client/models/create_ai_platform_connector.py +vectorize_client/models/create_ai_platform_connector_response.py +vectorize_client/models/create_destination_connector.py +vectorize_client/models/create_destination_connector_response.py +vectorize_client/models/create_pipeline_response.py +vectorize_client/models/create_pipeline_response_data.py +vectorize_client/models/create_source_connector.py +vectorize_client/models/create_source_connector_response.py +vectorize_client/models/created_ai_platform_connector.py +vectorize_client/models/created_destination_connector.py +vectorize_client/models/created_source_connector.py +vectorize_client/models/deep_research_result.py +vectorize_client/models/delete_ai_platform_connector_response.py +vectorize_client/models/delete_destination_connector_response.py +vectorize_client/models/delete_file_response.py +vectorize_client/models/delete_pipeline_response.py +vectorize_client/models/delete_source_connector_response.py +vectorize_client/models/destination_connector.py +vectorize_client/models/destination_connector_schema.py +vectorize_client/models/destination_connector_type.py +vectorize_client/models/document.py +vectorize_client/models/extraction_chunking_strategy.py +vectorize_client/models/extraction_result.py +vectorize_client/models/extraction_result_response.py +vectorize_client/models/extraction_type.py +vectorize_client/models/get_deep_research_response.py +vectorize_client/models/get_pipeline_events_response.py +vectorize_client/models/get_pipeline_metrics_response.py +vectorize_client/models/get_pipeline_response.py +vectorize_client/models/get_pipelines400_response.py +vectorize_client/models/get_pipelines_response.py +vectorize_client/models/get_upload_files_response.py +vectorize_client/models/metadata_extraction_strategy.py +vectorize_client/models/metadata_extraction_strategy_schema.py +vectorize_client/models/n8_n_config.py +vectorize_client/models/pipeline_configuration_schema.py +vectorize_client/models/pipeline_events.py +vectorize_client/models/pipeline_list_summary.py +vectorize_client/models/pipeline_metrics.py +vectorize_client/models/pipeline_summary.py +vectorize_client/models/remove_user_from_source_connector_request.py +vectorize_client/models/remove_user_from_source_connector_response.py +vectorize_client/models/retrieve_context.py +vectorize_client/models/retrieve_context_message.py +vectorize_client/models/retrieve_documents_request.py +vectorize_client/models/retrieve_documents_response.py +vectorize_client/models/schedule_schema.py +vectorize_client/models/schedule_schema_type.py +vectorize_client/models/source_connector.py +vectorize_client/models/source_connector_schema.py +vectorize_client/models/source_connector_type.py +vectorize_client/models/start_deep_research_request.py +vectorize_client/models/start_deep_research_response.py +vectorize_client/models/start_extraction_request.py +vectorize_client/models/start_extraction_response.py +vectorize_client/models/start_file_upload_request.py +vectorize_client/models/start_file_upload_response.py +vectorize_client/models/start_file_upload_to_connector_request.py +vectorize_client/models/start_file_upload_to_connector_response.py +vectorize_client/models/start_pipeline_response.py +vectorize_client/models/stop_pipeline_response.py +vectorize_client/models/update_ai_platform_connector_request.py +vectorize_client/models/update_ai_platform_connector_response.py +vectorize_client/models/update_destination_connector_request.py +vectorize_client/models/update_destination_connector_response.py +vectorize_client/models/update_source_connector_request.py +vectorize_client/models/update_source_connector_response.py +vectorize_client/models/update_source_connector_response_data.py +vectorize_client/models/update_user_in_source_connector_request.py +vectorize_client/models/update_user_in_source_connector_response.py +vectorize_client/models/updated_ai_platform_connector_data.py +vectorize_client/models/updated_destination_connector_data.py +vectorize_client/models/upload_file.py +vectorize_client/py.typed +vectorize_client/rest.py diff --git a/.openapi-generator/VERSION b/.openapi-generator/VERSION new file mode 100644 index 0000000..e465da4 --- /dev/null +++ b/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.14.0 diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..6b7cfde --- /dev/null +++ b/.travis.yml @@ -0,0 +1,17 @@ +# ref: https://docs.travis-ci.com/user/languages/python +language: python +python: + - "3.9" + - "3.10" + - "3.11" + - "3.12" + - "3.13" + # uncomment the following if needed + #- "3.13-dev" # 3.13 development branch + #- "nightly" # nightly build +# command to install dependencies +install: + - "pip install -r requirements.txt" + - "pip install -r test-requirements.txt" +# command to run tests +script: pytest --cov=vectorize_client diff --git a/README.md b/README.md index 96e6660..a6c2a7e 100644 --- a/README.md +++ b/README.md @@ -1,52 +1,203 @@ -# Vectorize Clients +# vectorize-client +API for Vectorize services -

- - PyPI - - - Pypi - - - NPM - -

+This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: -This repository contains source and test code for **Vectorize** clients in different languages. +- API version: 0.0.1 +- Package version: 1.0.0 +- Generator version: 7.14.0 +- Build package: org.openapitools.codegen.languages.PythonClientCodegen +For more information, please visit [https://vectorize.io](https://vectorize.io) -The clients are generated automatically using OpenAPI generator, starting from the OpenAPI specification in the `vectorize_api.json` file that is downloaded from the [Vectorize Platform OpenAPI endpoint](https://platform.vectorize.io/api/openapi). +## Requirements. +Python 3.9+ -## How to -- Python - - [Getting started](./src/python/README.md) - - [Official documentation](https://docs.vectorize.io/api/api-getting-started) - - [Code Reference](https://vectorize-io.github.io/vectorize-clients/python/vectorize_client/api.html) -- TypeScript - - [Getting started](./src/ts/README.md) - - [Official documentation](https://docs.vectorize.io/api/api-getting-started) - - [Code Reference](https://vectorize-io.github.io/vectorize-clients/ts/) +## Installation & Usage +### pip install +If the python package is hosted on a repository, you can install directly using: +```sh +pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git +``` +(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`) + +Then import the package: +```python +import vectorize_client +``` -## Generate and release clients -To generate a client, run the following command: +### Setuptools -```bash -npm install +Install via [Setuptools](http://pypi.python.org/pypi/setuptools). + +```sh +python setup.py install --user +``` +(or `sudo python setup.py install` to install the package for all users) -npm run generate:ts -npm run generate:python +Then import the package: +```python +import vectorize_client ``` -To release a client, run the following command: +### Tests + +Execute `pytest` to run the tests. + +## Getting Started + +Please follow the [installation procedure](#installation--usage) and then run the following: + +```python -```bash -npm install +import vectorize_client +from vectorize_client.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://api.vectorize.io/v1 +# See configuration.py for a list of all supported configuration parameters. +configuration = vectorize_client.Configuration( + host = "https://api.vectorize.io/v1" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure Bearer authorization (JWT): bearerAuth +configuration = vectorize_client.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + + +# Enter a context with an instance of the API client +with vectorize_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = vectorize_client.PipelinesApi(api_client) + organization = 'organization_example' # str | + pipeline_configuration_schema = vectorize_client.PipelineConfigurationSchema() # PipelineConfigurationSchema | + + try: + # Create a new source pipeline. Config fields for sources: Amazon S3 (AWS_S3): Check for updates every (seconds) (idle-time): number, Path Prefix (path-prefix): text, Path Metadata Regex (path-metadata-regex): text, Path Regex Group Names (path-regex-group-names): array oftext) | Azure Blob Storage (AZURE_BLOB): Polling Interval (seconds) (idle-time): number, Path Prefix (path-prefix): text, Path Metadata Regex (path-metadata-regex): text, Path Regex Group Names (path-regex-group-names): array oftext) | Confluence (CONFLUENCE): Spaces (spaces): array oftext, Root Parents (root-parents): array oftext) | Discord (DISCORD): Emoji Filter (emoji): array oftext, Author Filter (author): array oftext, Ignore Author Filter (ignore-author): array oftext, Limit (limit): number) | Dropbox (DROPBOX): Read from these folders (optional) (path-prefix): array oftext) | Google Drive OAuth (GOOGLE_DRIVE_OAUTH): Polling Interval (seconds) (idle-time): number) | Google Drive (Service Account) (GOOGLE_DRIVE): Restrict ingest to these folder URLs (optional) (root-parents): array oftext, Polling Interval (seconds) (idle-time): number) | Google Drive Multi-User (Vectorize) (GOOGLE_DRIVE_OAUTH_MULTI): Polling Interval (seconds) (idle-time): number) | Google Drive Multi-User (White Label) (GOOGLE_DRIVE_OAUTH_MULTI_CUSTOM): Polling Interval (seconds) (idle-time): number) | Firecrawl (FIRECRAWL): ) | GCP Cloud Storage (GCS): Check for updates every (seconds) (idle-time): number, Path Prefix (path-prefix): text, Path Metadata Regex (path-metadata-regex): text, Path Regex Group Names (path-regex-group-names): array oftext) | Intercom (INTERCOM): Reindex Interval (seconds) (reindexIntervalSeconds): number, Limit (limit): number, Tags (tags): array oftext) | OneDrive (ONE_DRIVE): Read starting from this folder (optional) (path-prefix): text) | SharePoint (SHAREPOINT): Site Name(s) (sites): array oftext) | Web Crawler (WEB_CRAWLER): Additional Allowed URLs or prefix(es) (allowed-domains-opt): array ofurl, Forbidden Paths (forbidden-paths): array oftext, Throttle (ms) (min-time-between-requests): number, Max Error Count (max-error-count): number, Max URLs (max-urls): number, Max Depth (max-depth): number, Reindex Interval (seconds) (reindex-interval-seconds): number) | File Upload (FILE_UPLOAD): ). Config fields for destinations: Couchbase Capella (CAPELLA): Bucket Name (bucket): text, Scope Name (scope): text, Collection Name (collection): text, Search Index Name (index): text) | DataStax Astra (DATASTAX): Collection Name (collection): text) | Elasticsearch (ELASTIC): Index Name (index): text) | Pinecone (PINECONE): Index Name (index): text, Namespace (namespace): text) | SingleStore (SINGLESTORE): Table Name (table): text) | Milvus (MILVUS): Collection Name (collection): text) | PostgreSQL (POSTGRESQL): Table Name (table): text) | Qdrant (QDRANT): Collection Name (collection): text) | Supabase (SUPABASE): Table Name (table): text) | Weaviate (WEAVIATE): Collection Name (collection): text) | Azure AI Search (AZUREAISEARCH): Index Name (index): text) | Built-in (VECTORIZE): ) | Chroma (CHROMA): Index Name (index): text) | MongoDB (MONGODB): Index Name (index): text). Config fields for AI platforms: + api_response = api_instance.create_pipeline(organization, pipeline_configuration_schema) + print("The response of PipelinesApi->create_pipeline:\n") + pprint(api_response) + except ApiException as e: + print("Exception when calling PipelinesApi->create_pipeline: %s\n" % e) -npm run release:ts -npm run release:python ``` +## Documentation for API Endpoints + +All URIs are relative to *https://api.vectorize.io/v1* + +Class | Method | HTTP request | Description +------------ | ------------- | ------------- | ------------- +*PipelinesApi* | [**create_pipeline**](docs/PipelinesApi.md#create_pipeline) | **POST** /org/{organization}/pipelines | Create a new source pipeline. Config fields for sources: Amazon S3 (AWS_S3): Check for updates every (seconds) (idle-time): number, Path Prefix (path-prefix): text, Path Metadata Regex (path-metadata-regex): text, Path Regex Group Names (path-regex-group-names): array oftext) | Azure Blob Storage (AZURE_BLOB): Polling Interval (seconds) (idle-time): number, Path Prefix (path-prefix): text, Path Metadata Regex (path-metadata-regex): text, Path Regex Group Names (path-regex-group-names): array oftext) | Confluence (CONFLUENCE): Spaces (spaces): array oftext, Root Parents (root-parents): array oftext) | Discord (DISCORD): Emoji Filter (emoji): array oftext, Author Filter (author): array oftext, Ignore Author Filter (ignore-author): array oftext, Limit (limit): number) | Dropbox (DROPBOX): Read from these folders (optional) (path-prefix): array oftext) | Google Drive OAuth (GOOGLE_DRIVE_OAUTH): Polling Interval (seconds) (idle-time): number) | Google Drive (Service Account) (GOOGLE_DRIVE): Restrict ingest to these folder URLs (optional) (root-parents): array oftext, Polling Interval (seconds) (idle-time): number) | Google Drive Multi-User (Vectorize) (GOOGLE_DRIVE_OAUTH_MULTI): Polling Interval (seconds) (idle-time): number) | Google Drive Multi-User (White Label) (GOOGLE_DRIVE_OAUTH_MULTI_CUSTOM): Polling Interval (seconds) (idle-time): number) | Firecrawl (FIRECRAWL): ) | GCP Cloud Storage (GCS): Check for updates every (seconds) (idle-time): number, Path Prefix (path-prefix): text, Path Metadata Regex (path-metadata-regex): text, Path Regex Group Names (path-regex-group-names): array oftext) | Intercom (INTERCOM): Reindex Interval (seconds) (reindexIntervalSeconds): number, Limit (limit): number, Tags (tags): array oftext) | OneDrive (ONE_DRIVE): Read starting from this folder (optional) (path-prefix): text) | SharePoint (SHAREPOINT): Site Name(s) (sites): array oftext) | Web Crawler (WEB_CRAWLER): Additional Allowed URLs or prefix(es) (allowed-domains-opt): array ofurl, Forbidden Paths (forbidden-paths): array oftext, Throttle (ms) (min-time-between-requests): number, Max Error Count (max-error-count): number, Max URLs (max-urls): number, Max Depth (max-depth): number, Reindex Interval (seconds) (reindex-interval-seconds): number) | File Upload (FILE_UPLOAD): ). Config fields for destinations: Couchbase Capella (CAPELLA): Bucket Name (bucket): text, Scope Name (scope): text, Collection Name (collection): text, Search Index Name (index): text) | DataStax Astra (DATASTAX): Collection Name (collection): text) | Elasticsearch (ELASTIC): Index Name (index): text) | Pinecone (PINECONE): Index Name (index): text, Namespace (namespace): text) | SingleStore (SINGLESTORE): Table Name (table): text) | Milvus (MILVUS): Collection Name (collection): text) | PostgreSQL (POSTGRESQL): Table Name (table): text) | Qdrant (QDRANT): Collection Name (collection): text) | Supabase (SUPABASE): Table Name (table): text) | Weaviate (WEAVIATE): Collection Name (collection): text) | Azure AI Search (AZUREAISEARCH): Index Name (index): text) | Built-in (VECTORIZE): ) | Chroma (CHROMA): Index Name (index): text) | MongoDB (MONGODB): Index Name (index): text). Config fields for AI platforms: +*PipelinesApi* | [**get_pipelines**](docs/PipelinesApi.md#get_pipelines) | **GET** /org/{organization}/pipelines | Get all existing pipelines + + +## Documentation For Models + + - [AIPlatform](docs/AIPlatform.md) + - [AIPlatformConfigSchema](docs/AIPlatformConfigSchema.md) + - [AIPlatformSchema](docs/AIPlatformSchema.md) + - [AIPlatformType](docs/AIPlatformType.md) + - [AddUserFromSourceConnectorResponse](docs/AddUserFromSourceConnectorResponse.md) + - [AddUserToSourceConnectorRequest](docs/AddUserToSourceConnectorRequest.md) + - [AddUserToSourceConnectorRequestSelectedFilesValue](docs/AddUserToSourceConnectorRequestSelectedFilesValue.md) + - [AdvancedQuery](docs/AdvancedQuery.md) + - [CreateAIPlatformConnector](docs/CreateAIPlatformConnector.md) + - [CreateAIPlatformConnectorResponse](docs/CreateAIPlatformConnectorResponse.md) + - [CreateDestinationConnector](docs/CreateDestinationConnector.md) + - [CreateDestinationConnectorResponse](docs/CreateDestinationConnectorResponse.md) + - [CreatePipelineResponse](docs/CreatePipelineResponse.md) + - [CreatePipelineResponseData](docs/CreatePipelineResponseData.md) + - [CreateSourceConnector](docs/CreateSourceConnector.md) + - [CreateSourceConnectorResponse](docs/CreateSourceConnectorResponse.md) + - [CreatedAIPlatformConnector](docs/CreatedAIPlatformConnector.md) + - [CreatedDestinationConnector](docs/CreatedDestinationConnector.md) + - [CreatedSourceConnector](docs/CreatedSourceConnector.md) + - [DeepResearchResult](docs/DeepResearchResult.md) + - [DeleteAIPlatformConnectorResponse](docs/DeleteAIPlatformConnectorResponse.md) + - [DeleteDestinationConnectorResponse](docs/DeleteDestinationConnectorResponse.md) + - [DeleteFileResponse](docs/DeleteFileResponse.md) + - [DeletePipelineResponse](docs/DeletePipelineResponse.md) + - [DeleteSourceConnectorResponse](docs/DeleteSourceConnectorResponse.md) + - [DestinationConnector](docs/DestinationConnector.md) + - [DestinationConnectorSchema](docs/DestinationConnectorSchema.md) + - [DestinationConnectorType](docs/DestinationConnectorType.md) + - [Document](docs/Document.md) + - [ExtractionChunkingStrategy](docs/ExtractionChunkingStrategy.md) + - [ExtractionResult](docs/ExtractionResult.md) + - [ExtractionResultResponse](docs/ExtractionResultResponse.md) + - [ExtractionType](docs/ExtractionType.md) + - [GetDeepResearchResponse](docs/GetDeepResearchResponse.md) + - [GetPipelineEventsResponse](docs/GetPipelineEventsResponse.md) + - [GetPipelineMetricsResponse](docs/GetPipelineMetricsResponse.md) + - [GetPipelineResponse](docs/GetPipelineResponse.md) + - [GetPipelines400Response](docs/GetPipelines400Response.md) + - [GetPipelinesResponse](docs/GetPipelinesResponse.md) + - [GetUploadFilesResponse](docs/GetUploadFilesResponse.md) + - [MetadataExtractionStrategy](docs/MetadataExtractionStrategy.md) + - [MetadataExtractionStrategySchema](docs/MetadataExtractionStrategySchema.md) + - [N8NConfig](docs/N8NConfig.md) + - [PipelineConfigurationSchema](docs/PipelineConfigurationSchema.md) + - [PipelineEvents](docs/PipelineEvents.md) + - [PipelineListSummary](docs/PipelineListSummary.md) + - [PipelineMetrics](docs/PipelineMetrics.md) + - [PipelineSummary](docs/PipelineSummary.md) + - [RemoveUserFromSourceConnectorRequest](docs/RemoveUserFromSourceConnectorRequest.md) + - [RemoveUserFromSourceConnectorResponse](docs/RemoveUserFromSourceConnectorResponse.md) + - [RetrieveContext](docs/RetrieveContext.md) + - [RetrieveContextMessage](docs/RetrieveContextMessage.md) + - [RetrieveDocumentsRequest](docs/RetrieveDocumentsRequest.md) + - [RetrieveDocumentsResponse](docs/RetrieveDocumentsResponse.md) + - [ScheduleSchema](docs/ScheduleSchema.md) + - [ScheduleSchemaType](docs/ScheduleSchemaType.md) + - [SourceConnector](docs/SourceConnector.md) + - [SourceConnectorSchema](docs/SourceConnectorSchema.md) + - [SourceConnectorType](docs/SourceConnectorType.md) + - [StartDeepResearchRequest](docs/StartDeepResearchRequest.md) + - [StartDeepResearchResponse](docs/StartDeepResearchResponse.md) + - [StartExtractionRequest](docs/StartExtractionRequest.md) + - [StartExtractionResponse](docs/StartExtractionResponse.md) + - [StartFileUploadRequest](docs/StartFileUploadRequest.md) + - [StartFileUploadResponse](docs/StartFileUploadResponse.md) + - [StartFileUploadToConnectorRequest](docs/StartFileUploadToConnectorRequest.md) + - [StartFileUploadToConnectorResponse](docs/StartFileUploadToConnectorResponse.md) + - [StartPipelineResponse](docs/StartPipelineResponse.md) + - [StopPipelineResponse](docs/StopPipelineResponse.md) + - [UpdateAIPlatformConnectorRequest](docs/UpdateAIPlatformConnectorRequest.md) + - [UpdateAIPlatformConnectorResponse](docs/UpdateAIPlatformConnectorResponse.md) + - [UpdateDestinationConnectorRequest](docs/UpdateDestinationConnectorRequest.md) + - [UpdateDestinationConnectorResponse](docs/UpdateDestinationConnectorResponse.md) + - [UpdateSourceConnectorRequest](docs/UpdateSourceConnectorRequest.md) + - [UpdateSourceConnectorResponse](docs/UpdateSourceConnectorResponse.md) + - [UpdateSourceConnectorResponseData](docs/UpdateSourceConnectorResponseData.md) + - [UpdateUserInSourceConnectorRequest](docs/UpdateUserInSourceConnectorRequest.md) + - [UpdateUserInSourceConnectorResponse](docs/UpdateUserInSourceConnectorResponse.md) + - [UpdatedAIPlatformConnectorData](docs/UpdatedAIPlatformConnectorData.md) + - [UpdatedDestinationConnectorData](docs/UpdatedDestinationConnectorData.md) + - [UploadFile](docs/UploadFile.md) + + + +## Documentation For Authorization + + +Authentication schemes defined for the API: + +### bearerAuth + +- **Type**: Bearer authentication (JWT) + + +## Author + + diff --git a/docs/AIPlatform.md b/docs/AIPlatform.md new file mode 100644 index 0000000..96388e6 --- /dev/null +++ b/docs/AIPlatform.md @@ -0,0 +1,39 @@ +# AIPlatform + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | +**type** | **str** | | +**name** | **str** | | +**config_doc** | **Dict[str, Optional[object]]** | | [optional] +**created_at** | **str** | | [optional] +**created_by_id** | **str** | | [optional] +**last_updated_by_id** | **str** | | [optional] +**created_by_email** | **str** | | [optional] +**last_updated_by_email** | **str** | | [optional] +**error_message** | **str** | | [optional] +**verification_status** | **str** | | [optional] + +## Example + +```python +from vectorize_client.models.ai_platform import AIPlatform + +# TODO update the JSON string below +json = "{}" +# create an instance of AIPlatform from a JSON string +ai_platform_instance = AIPlatform.from_json(json) +# print the JSON string representation of the object +print(AIPlatform.to_json()) + +# convert the object into a dict +ai_platform_dict = ai_platform_instance.to_dict() +# create an instance of AIPlatform from a dict +ai_platform_from_dict = AIPlatform.from_dict(ai_platform_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/AIPlatformConfigSchema.md b/docs/AIPlatformConfigSchema.md new file mode 100644 index 0000000..6291b72 --- /dev/null +++ b/docs/AIPlatformConfigSchema.md @@ -0,0 +1,34 @@ +# AIPlatformConfigSchema + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**embedding_model** | **str** | | [optional] +**chunking_strategy** | **str** | | [optional] +**chunk_size** | **int** | | [optional] +**chunk_overlap** | **int** | | [optional] +**dimensions** | **int** | | [optional] +**extraction_strategy** | **str** | | [optional] + +## Example + +```python +from vectorize_client.models.ai_platform_config_schema import AIPlatformConfigSchema + +# TODO update the JSON string below +json = "{}" +# create an instance of AIPlatformConfigSchema from a JSON string +ai_platform_config_schema_instance = AIPlatformConfigSchema.from_json(json) +# print the JSON string representation of the object +print(AIPlatformConfigSchema.to_json()) + +# convert the object into a dict +ai_platform_config_schema_dict = ai_platform_config_schema_instance.to_dict() +# create an instance of AIPlatformConfigSchema from a dict +ai_platform_config_schema_from_dict = AIPlatformConfigSchema.from_dict(ai_platform_config_schema_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/AIPlatformSchema.md b/docs/AIPlatformSchema.md new file mode 100644 index 0000000..995b683 --- /dev/null +++ b/docs/AIPlatformSchema.md @@ -0,0 +1,31 @@ +# AIPlatformSchema + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | +**type** | [**AIPlatformType**](AIPlatformType.md) | | +**config** | [**AIPlatformConfigSchema**](AIPlatformConfigSchema.md) | | + +## Example + +```python +from vectorize_client.models.ai_platform_schema import AIPlatformSchema + +# TODO update the JSON string below +json = "{}" +# create an instance of AIPlatformSchema from a JSON string +ai_platform_schema_instance = AIPlatformSchema.from_json(json) +# print the JSON string representation of the object +print(AIPlatformSchema.to_json()) + +# convert the object into a dict +ai_platform_schema_dict = ai_platform_schema_instance.to_dict() +# create an instance of AIPlatformSchema from a dict +ai_platform_schema_from_dict = AIPlatformSchema.from_dict(ai_platform_schema_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/AIPlatformType.md b/docs/AIPlatformType.md new file mode 100644 index 0000000..7f8394b --- /dev/null +++ b/docs/AIPlatformType.md @@ -0,0 +1,18 @@ +# AIPlatformType + + +## Enum + +* `BEDROCK` (value: `'BEDROCK'`) + +* `VERTEX` (value: `'VERTEX'`) + +* `OPENAI` (value: `'OPENAI'`) + +* `VOYAGE` (value: `'VOYAGE'`) + +* `VECTORIZE` (value: `'VECTORIZE'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/AddUserFromSourceConnectorResponse.md b/docs/AddUserFromSourceConnectorResponse.md new file mode 100644 index 0000000..839f8df --- /dev/null +++ b/docs/AddUserFromSourceConnectorResponse.md @@ -0,0 +1,29 @@ +# AddUserFromSourceConnectorResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **str** | | + +## Example + +```python +from vectorize_client.models.add_user_from_source_connector_response import AddUserFromSourceConnectorResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of AddUserFromSourceConnectorResponse from a JSON string +add_user_from_source_connector_response_instance = AddUserFromSourceConnectorResponse.from_json(json) +# print the JSON string representation of the object +print(AddUserFromSourceConnectorResponse.to_json()) + +# convert the object into a dict +add_user_from_source_connector_response_dict = add_user_from_source_connector_response_instance.to_dict() +# create an instance of AddUserFromSourceConnectorResponse from a dict +add_user_from_source_connector_response_from_dict = AddUserFromSourceConnectorResponse.from_dict(add_user_from_source_connector_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/AddUserToSourceConnectorRequest.md b/docs/AddUserToSourceConnectorRequest.md new file mode 100644 index 0000000..299a2a0 --- /dev/null +++ b/docs/AddUserToSourceConnectorRequest.md @@ -0,0 +1,31 @@ +# AddUserToSourceConnectorRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**user_id** | **str** | | +**selected_files** | [**Dict[str, AddUserToSourceConnectorRequestSelectedFilesValue]**](AddUserToSourceConnectorRequestSelectedFilesValue.md) | | +**refresh_token** | **str** | | + +## Example + +```python +from vectorize_client.models.add_user_to_source_connector_request import AddUserToSourceConnectorRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of AddUserToSourceConnectorRequest from a JSON string +add_user_to_source_connector_request_instance = AddUserToSourceConnectorRequest.from_json(json) +# print the JSON string representation of the object +print(AddUserToSourceConnectorRequest.to_json()) + +# convert the object into a dict +add_user_to_source_connector_request_dict = add_user_to_source_connector_request_instance.to_dict() +# create an instance of AddUserToSourceConnectorRequest from a dict +add_user_to_source_connector_request_from_dict = AddUserToSourceConnectorRequest.from_dict(add_user_to_source_connector_request_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/AddUserToSourceConnectorRequestSelectedFilesValue.md b/docs/AddUserToSourceConnectorRequestSelectedFilesValue.md new file mode 100644 index 0000000..ea9b1ff --- /dev/null +++ b/docs/AddUserToSourceConnectorRequestSelectedFilesValue.md @@ -0,0 +1,30 @@ +# AddUserToSourceConnectorRequestSelectedFilesValue + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | | +**mime_type** | **str** | | + +## Example + +```python +from vectorize_client.models.add_user_to_source_connector_request_selected_files_value import AddUserToSourceConnectorRequestSelectedFilesValue + +# TODO update the JSON string below +json = "{}" +# create an instance of AddUserToSourceConnectorRequestSelectedFilesValue from a JSON string +add_user_to_source_connector_request_selected_files_value_instance = AddUserToSourceConnectorRequestSelectedFilesValue.from_json(json) +# print the JSON string representation of the object +print(AddUserToSourceConnectorRequestSelectedFilesValue.to_json()) + +# convert the object into a dict +add_user_to_source_connector_request_selected_files_value_dict = add_user_to_source_connector_request_selected_files_value_instance.to_dict() +# create an instance of AddUserToSourceConnectorRequestSelectedFilesValue from a dict +add_user_to_source_connector_request_selected_files_value_from_dict = AddUserToSourceConnectorRequestSelectedFilesValue.from_dict(add_user_to_source_connector_request_selected_files_value_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/AdvancedQuery.md b/docs/AdvancedQuery.md new file mode 100644 index 0000000..9cbc785 --- /dev/null +++ b/docs/AdvancedQuery.md @@ -0,0 +1,34 @@ +# AdvancedQuery + +Advanced query configuration for document retrieval + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**mode** | **str** | Query mode - text, vector, or hybrid | [optional] [default to 'vector'] +**text_fields** | **List[str]** | Fields to search in text mode | [optional] +**match_type** | **str** | Text matching type | [optional] +**text_boost** | **float** | Boost factor for text queries | [optional] [default to 1.0] +**filters** | **Dict[str, object]** | Filters to apply to the query (Elasticsearch-style filters) | [optional] + +## Example + +```python +from vectorize_client.models.advanced_query import AdvancedQuery + +# TODO update the JSON string below +json = "{}" +# create an instance of AdvancedQuery from a JSON string +advanced_query_instance = AdvancedQuery.from_json(json) +# print the JSON string representation of the object +print(AdvancedQuery.to_json()) + +# convert the object into a dict +advanced_query_dict = advanced_query_instance.to_dict() +# create an instance of AdvancedQuery from a dict +advanced_query_from_dict = AdvancedQuery.from_dict(advanced_query_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CreateAIPlatformConnector.md b/docs/CreateAIPlatformConnector.md new file mode 100644 index 0000000..aa2b666 --- /dev/null +++ b/docs/CreateAIPlatformConnector.md @@ -0,0 +1,31 @@ +# CreateAIPlatformConnector + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | | +**type** | [**AIPlatformType**](AIPlatformType.md) | | +**config** | **Dict[str, Optional[object]]** | | [optional] + +## Example + +```python +from vectorize_client.models.create_ai_platform_connector import CreateAIPlatformConnector + +# TODO update the JSON string below +json = "{}" +# create an instance of CreateAIPlatformConnector from a JSON string +create_ai_platform_connector_instance = CreateAIPlatformConnector.from_json(json) +# print the JSON string representation of the object +print(CreateAIPlatformConnector.to_json()) + +# convert the object into a dict +create_ai_platform_connector_dict = create_ai_platform_connector_instance.to_dict() +# create an instance of CreateAIPlatformConnector from a dict +create_ai_platform_connector_from_dict = CreateAIPlatformConnector.from_dict(create_ai_platform_connector_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CreateAIPlatformConnectorResponse.md b/docs/CreateAIPlatformConnectorResponse.md new file mode 100644 index 0000000..7727f5e --- /dev/null +++ b/docs/CreateAIPlatformConnectorResponse.md @@ -0,0 +1,30 @@ +# CreateAIPlatformConnectorResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **str** | | +**connectors** | [**List[CreatedAIPlatformConnector]**](CreatedAIPlatformConnector.md) | | + +## Example + +```python +from vectorize_client.models.create_ai_platform_connector_response import CreateAIPlatformConnectorResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of CreateAIPlatformConnectorResponse from a JSON string +create_ai_platform_connector_response_instance = CreateAIPlatformConnectorResponse.from_json(json) +# print the JSON string representation of the object +print(CreateAIPlatformConnectorResponse.to_json()) + +# convert the object into a dict +create_ai_platform_connector_response_dict = create_ai_platform_connector_response_instance.to_dict() +# create an instance of CreateAIPlatformConnectorResponse from a dict +create_ai_platform_connector_response_from_dict = CreateAIPlatformConnectorResponse.from_dict(create_ai_platform_connector_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CreateDestinationConnector.md b/docs/CreateDestinationConnector.md new file mode 100644 index 0000000..0cf3211 --- /dev/null +++ b/docs/CreateDestinationConnector.md @@ -0,0 +1,31 @@ +# CreateDestinationConnector + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | | +**type** | [**DestinationConnectorType**](DestinationConnectorType.md) | | +**config** | **Dict[str, Optional[object]]** | | [optional] + +## Example + +```python +from vectorize_client.models.create_destination_connector import CreateDestinationConnector + +# TODO update the JSON string below +json = "{}" +# create an instance of CreateDestinationConnector from a JSON string +create_destination_connector_instance = CreateDestinationConnector.from_json(json) +# print the JSON string representation of the object +print(CreateDestinationConnector.to_json()) + +# convert the object into a dict +create_destination_connector_dict = create_destination_connector_instance.to_dict() +# create an instance of CreateDestinationConnector from a dict +create_destination_connector_from_dict = CreateDestinationConnector.from_dict(create_destination_connector_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CreateDestinationConnectorResponse.md b/docs/CreateDestinationConnectorResponse.md new file mode 100644 index 0000000..67140c9 --- /dev/null +++ b/docs/CreateDestinationConnectorResponse.md @@ -0,0 +1,30 @@ +# CreateDestinationConnectorResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **str** | | +**connectors** | [**List[CreatedDestinationConnector]**](CreatedDestinationConnector.md) | | + +## Example + +```python +from vectorize_client.models.create_destination_connector_response import CreateDestinationConnectorResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of CreateDestinationConnectorResponse from a JSON string +create_destination_connector_response_instance = CreateDestinationConnectorResponse.from_json(json) +# print the JSON string representation of the object +print(CreateDestinationConnectorResponse.to_json()) + +# convert the object into a dict +create_destination_connector_response_dict = create_destination_connector_response_instance.to_dict() +# create an instance of CreateDestinationConnectorResponse from a dict +create_destination_connector_response_from_dict = CreateDestinationConnectorResponse.from_dict(create_destination_connector_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CreatePipelineResponse.md b/docs/CreatePipelineResponse.md new file mode 100644 index 0000000..752d37f --- /dev/null +++ b/docs/CreatePipelineResponse.md @@ -0,0 +1,30 @@ +# CreatePipelineResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **str** | | +**data** | [**CreatePipelineResponseData**](CreatePipelineResponseData.md) | | + +## Example + +```python +from vectorize_client.models.create_pipeline_response import CreatePipelineResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of CreatePipelineResponse from a JSON string +create_pipeline_response_instance = CreatePipelineResponse.from_json(json) +# print the JSON string representation of the object +print(CreatePipelineResponse.to_json()) + +# convert the object into a dict +create_pipeline_response_dict = create_pipeline_response_instance.to_dict() +# create an instance of CreatePipelineResponse from a dict +create_pipeline_response_from_dict = CreatePipelineResponse.from_dict(create_pipeline_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CreatePipelineResponseData.md b/docs/CreatePipelineResponseData.md new file mode 100644 index 0000000..7e86a7a --- /dev/null +++ b/docs/CreatePipelineResponseData.md @@ -0,0 +1,29 @@ +# CreatePipelineResponseData + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | + +## Example + +```python +from vectorize_client.models.create_pipeline_response_data import CreatePipelineResponseData + +# TODO update the JSON string below +json = "{}" +# create an instance of CreatePipelineResponseData from a JSON string +create_pipeline_response_data_instance = CreatePipelineResponseData.from_json(json) +# print the JSON string representation of the object +print(CreatePipelineResponseData.to_json()) + +# convert the object into a dict +create_pipeline_response_data_dict = create_pipeline_response_data_instance.to_dict() +# create an instance of CreatePipelineResponseData from a dict +create_pipeline_response_data_from_dict = CreatePipelineResponseData.from_dict(create_pipeline_response_data_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CreateSourceConnector.md b/docs/CreateSourceConnector.md new file mode 100644 index 0000000..c8674f1 --- /dev/null +++ b/docs/CreateSourceConnector.md @@ -0,0 +1,31 @@ +# CreateSourceConnector + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | | +**type** | [**SourceConnectorType**](SourceConnectorType.md) | | +**config** | **Dict[str, Optional[object]]** | | [optional] + +## Example + +```python +from vectorize_client.models.create_source_connector import CreateSourceConnector + +# TODO update the JSON string below +json = "{}" +# create an instance of CreateSourceConnector from a JSON string +create_source_connector_instance = CreateSourceConnector.from_json(json) +# print the JSON string representation of the object +print(CreateSourceConnector.to_json()) + +# convert the object into a dict +create_source_connector_dict = create_source_connector_instance.to_dict() +# create an instance of CreateSourceConnector from a dict +create_source_connector_from_dict = CreateSourceConnector.from_dict(create_source_connector_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CreateSourceConnectorResponse.md b/docs/CreateSourceConnectorResponse.md new file mode 100644 index 0000000..7124435 --- /dev/null +++ b/docs/CreateSourceConnectorResponse.md @@ -0,0 +1,30 @@ +# CreateSourceConnectorResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **str** | | +**connectors** | [**List[CreatedSourceConnector]**](CreatedSourceConnector.md) | | + +## Example + +```python +from vectorize_client.models.create_source_connector_response import CreateSourceConnectorResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of CreateSourceConnectorResponse from a JSON string +create_source_connector_response_instance = CreateSourceConnectorResponse.from_json(json) +# print the JSON string representation of the object +print(CreateSourceConnectorResponse.to_json()) + +# convert the object into a dict +create_source_connector_response_dict = create_source_connector_response_instance.to_dict() +# create an instance of CreateSourceConnectorResponse from a dict +create_source_connector_response_from_dict = CreateSourceConnectorResponse.from_dict(create_source_connector_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CreatedAIPlatformConnector.md b/docs/CreatedAIPlatformConnector.md new file mode 100644 index 0000000..c6131de --- /dev/null +++ b/docs/CreatedAIPlatformConnector.md @@ -0,0 +1,30 @@ +# CreatedAIPlatformConnector + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | | +**id** | **str** | | + +## Example + +```python +from vectorize_client.models.created_ai_platform_connector import CreatedAIPlatformConnector + +# TODO update the JSON string below +json = "{}" +# create an instance of CreatedAIPlatformConnector from a JSON string +created_ai_platform_connector_instance = CreatedAIPlatformConnector.from_json(json) +# print the JSON string representation of the object +print(CreatedAIPlatformConnector.to_json()) + +# convert the object into a dict +created_ai_platform_connector_dict = created_ai_platform_connector_instance.to_dict() +# create an instance of CreatedAIPlatformConnector from a dict +created_ai_platform_connector_from_dict = CreatedAIPlatformConnector.from_dict(created_ai_platform_connector_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CreatedDestinationConnector.md b/docs/CreatedDestinationConnector.md new file mode 100644 index 0000000..236a87a --- /dev/null +++ b/docs/CreatedDestinationConnector.md @@ -0,0 +1,30 @@ +# CreatedDestinationConnector + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | | +**id** | **str** | | + +## Example + +```python +from vectorize_client.models.created_destination_connector import CreatedDestinationConnector + +# TODO update the JSON string below +json = "{}" +# create an instance of CreatedDestinationConnector from a JSON string +created_destination_connector_instance = CreatedDestinationConnector.from_json(json) +# print the JSON string representation of the object +print(CreatedDestinationConnector.to_json()) + +# convert the object into a dict +created_destination_connector_dict = created_destination_connector_instance.to_dict() +# create an instance of CreatedDestinationConnector from a dict +created_destination_connector_from_dict = CreatedDestinationConnector.from_dict(created_destination_connector_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CreatedSourceConnector.md b/docs/CreatedSourceConnector.md new file mode 100644 index 0000000..471753b --- /dev/null +++ b/docs/CreatedSourceConnector.md @@ -0,0 +1,30 @@ +# CreatedSourceConnector + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | | +**id** | **str** | | + +## Example + +```python +from vectorize_client.models.created_source_connector import CreatedSourceConnector + +# TODO update the JSON string below +json = "{}" +# create an instance of CreatedSourceConnector from a JSON string +created_source_connector_instance = CreatedSourceConnector.from_json(json) +# print the JSON string representation of the object +print(CreatedSourceConnector.to_json()) + +# convert the object into a dict +created_source_connector_dict = created_source_connector_instance.to_dict() +# create an instance of CreatedSourceConnector from a dict +created_source_connector_from_dict = CreatedSourceConnector.from_dict(created_source_connector_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/DeepResearchResult.md b/docs/DeepResearchResult.md new file mode 100644 index 0000000..860c339 --- /dev/null +++ b/docs/DeepResearchResult.md @@ -0,0 +1,32 @@ +# DeepResearchResult + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**success** | **bool** | | +**events** | **List[str]** | | [optional] +**markdown** | **str** | | [optional] +**error** | **str** | | [optional] + +## Example + +```python +from vectorize_client.models.deep_research_result import DeepResearchResult + +# TODO update the JSON string below +json = "{}" +# create an instance of DeepResearchResult from a JSON string +deep_research_result_instance = DeepResearchResult.from_json(json) +# print the JSON string representation of the object +print(DeepResearchResult.to_json()) + +# convert the object into a dict +deep_research_result_dict = deep_research_result_instance.to_dict() +# create an instance of DeepResearchResult from a dict +deep_research_result_from_dict = DeepResearchResult.from_dict(deep_research_result_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/DeleteAIPlatformConnectorResponse.md b/docs/DeleteAIPlatformConnectorResponse.md new file mode 100644 index 0000000..106ddaf --- /dev/null +++ b/docs/DeleteAIPlatformConnectorResponse.md @@ -0,0 +1,29 @@ +# DeleteAIPlatformConnectorResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **str** | | + +## Example + +```python +from vectorize_client.models.delete_ai_platform_connector_response import DeleteAIPlatformConnectorResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of DeleteAIPlatformConnectorResponse from a JSON string +delete_ai_platform_connector_response_instance = DeleteAIPlatformConnectorResponse.from_json(json) +# print the JSON string representation of the object +print(DeleteAIPlatformConnectorResponse.to_json()) + +# convert the object into a dict +delete_ai_platform_connector_response_dict = delete_ai_platform_connector_response_instance.to_dict() +# create an instance of DeleteAIPlatformConnectorResponse from a dict +delete_ai_platform_connector_response_from_dict = DeleteAIPlatformConnectorResponse.from_dict(delete_ai_platform_connector_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/DeleteDestinationConnectorResponse.md b/docs/DeleteDestinationConnectorResponse.md new file mode 100644 index 0000000..4a80311 --- /dev/null +++ b/docs/DeleteDestinationConnectorResponse.md @@ -0,0 +1,29 @@ +# DeleteDestinationConnectorResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **str** | | + +## Example + +```python +from vectorize_client.models.delete_destination_connector_response import DeleteDestinationConnectorResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of DeleteDestinationConnectorResponse from a JSON string +delete_destination_connector_response_instance = DeleteDestinationConnectorResponse.from_json(json) +# print the JSON string representation of the object +print(DeleteDestinationConnectorResponse.to_json()) + +# convert the object into a dict +delete_destination_connector_response_dict = delete_destination_connector_response_instance.to_dict() +# create an instance of DeleteDestinationConnectorResponse from a dict +delete_destination_connector_response_from_dict = DeleteDestinationConnectorResponse.from_dict(delete_destination_connector_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/DeleteFileResponse.md b/docs/DeleteFileResponse.md new file mode 100644 index 0000000..7a3df62 --- /dev/null +++ b/docs/DeleteFileResponse.md @@ -0,0 +1,30 @@ +# DeleteFileResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **str** | | +**file_name** | **str** | | + +## Example + +```python +from vectorize_client.models.delete_file_response import DeleteFileResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of DeleteFileResponse from a JSON string +delete_file_response_instance = DeleteFileResponse.from_json(json) +# print the JSON string representation of the object +print(DeleteFileResponse.to_json()) + +# convert the object into a dict +delete_file_response_dict = delete_file_response_instance.to_dict() +# create an instance of DeleteFileResponse from a dict +delete_file_response_from_dict = DeleteFileResponse.from_dict(delete_file_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/DeletePipelineResponse.md b/docs/DeletePipelineResponse.md new file mode 100644 index 0000000..ab7c475 --- /dev/null +++ b/docs/DeletePipelineResponse.md @@ -0,0 +1,29 @@ +# DeletePipelineResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **str** | | + +## Example + +```python +from vectorize_client.models.delete_pipeline_response import DeletePipelineResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of DeletePipelineResponse from a JSON string +delete_pipeline_response_instance = DeletePipelineResponse.from_json(json) +# print the JSON string representation of the object +print(DeletePipelineResponse.to_json()) + +# convert the object into a dict +delete_pipeline_response_dict = delete_pipeline_response_instance.to_dict() +# create an instance of DeletePipelineResponse from a dict +delete_pipeline_response_from_dict = DeletePipelineResponse.from_dict(delete_pipeline_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/DeleteSourceConnectorResponse.md b/docs/DeleteSourceConnectorResponse.md new file mode 100644 index 0000000..c8e57e2 --- /dev/null +++ b/docs/DeleteSourceConnectorResponse.md @@ -0,0 +1,29 @@ +# DeleteSourceConnectorResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **str** | | + +## Example + +```python +from vectorize_client.models.delete_source_connector_response import DeleteSourceConnectorResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of DeleteSourceConnectorResponse from a JSON string +delete_source_connector_response_instance = DeleteSourceConnectorResponse.from_json(json) +# print the JSON string representation of the object +print(DeleteSourceConnectorResponse.to_json()) + +# convert the object into a dict +delete_source_connector_response_dict = delete_source_connector_response_instance.to_dict() +# create an instance of DeleteSourceConnectorResponse from a dict +delete_source_connector_response_from_dict = DeleteSourceConnectorResponse.from_dict(delete_source_connector_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/DestinationConnector.md b/docs/DestinationConnector.md new file mode 100644 index 0000000..62b1b7d --- /dev/null +++ b/docs/DestinationConnector.md @@ -0,0 +1,39 @@ +# DestinationConnector + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | +**type** | **str** | | +**name** | **str** | | +**config_doc** | **Dict[str, Optional[object]]** | | [optional] +**created_at** | **str** | | [optional] +**created_by_id** | **str** | | [optional] +**last_updated_by_id** | **str** | | [optional] +**created_by_email** | **str** | | [optional] +**last_updated_by_email** | **str** | | [optional] +**error_message** | **str** | | [optional] +**verification_status** | **str** | | [optional] + +## Example + +```python +from vectorize_client.models.destination_connector import DestinationConnector + +# TODO update the JSON string below +json = "{}" +# create an instance of DestinationConnector from a JSON string +destination_connector_instance = DestinationConnector.from_json(json) +# print the JSON string representation of the object +print(DestinationConnector.to_json()) + +# convert the object into a dict +destination_connector_dict = destination_connector_instance.to_dict() +# create an instance of DestinationConnector from a dict +destination_connector_from_dict = DestinationConnector.from_dict(destination_connector_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/DestinationConnectorSchema.md b/docs/DestinationConnectorSchema.md new file mode 100644 index 0000000..0c4cc7e --- /dev/null +++ b/docs/DestinationConnectorSchema.md @@ -0,0 +1,31 @@ +# DestinationConnectorSchema + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | +**type** | [**DestinationConnectorType**](DestinationConnectorType.md) | | +**config** | **Dict[str, Optional[object]]** | | [optional] + +## Example + +```python +from vectorize_client.models.destination_connector_schema import DestinationConnectorSchema + +# TODO update the JSON string below +json = "{}" +# create an instance of DestinationConnectorSchema from a JSON string +destination_connector_schema_instance = DestinationConnectorSchema.from_json(json) +# print the JSON string representation of the object +print(DestinationConnectorSchema.to_json()) + +# convert the object into a dict +destination_connector_schema_dict = destination_connector_schema_instance.to_dict() +# create an instance of DestinationConnectorSchema from a dict +destination_connector_schema_from_dict = DestinationConnectorSchema.from_dict(destination_connector_schema_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/DestinationConnectorType.md b/docs/DestinationConnectorType.md new file mode 100644 index 0000000..74a5df7 --- /dev/null +++ b/docs/DestinationConnectorType.md @@ -0,0 +1,36 @@ +# DestinationConnectorType + + +## Enum + +* `CAPELLA` (value: `'CAPELLA'`) + +* `DATASTAX` (value: `'DATASTAX'`) + +* `ELASTIC` (value: `'ELASTIC'`) + +* `PINECONE` (value: `'PINECONE'`) + +* `SINGLESTORE` (value: `'SINGLESTORE'`) + +* `MILVUS` (value: `'MILVUS'`) + +* `POSTGRESQL` (value: `'POSTGRESQL'`) + +* `QDRANT` (value: `'QDRANT'`) + +* `SUPABASE` (value: `'SUPABASE'`) + +* `WEAVIATE` (value: `'WEAVIATE'`) + +* `AZUREAISEARCH` (value: `'AZUREAISEARCH'`) + +* `VECTORIZE` (value: `'VECTORIZE'`) + +* `CHROMA` (value: `'CHROMA'`) + +* `MONGODB` (value: `'MONGODB'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Document.md b/docs/Document.md new file mode 100644 index 0000000..da775fe --- /dev/null +++ b/docs/Document.md @@ -0,0 +1,41 @@ +# Document + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**relevancy** | **float** | | +**id** | **str** | | +**text** | **str** | | +**chunk_id** | **str** | | +**total_chunks** | **str** | | +**origin** | **str** | | +**origin_id** | **str** | | +**similarity** | **float** | | +**source** | **str** | | +**unique_source** | **str** | | +**source_display_name** | **str** | | +**pipeline_id** | **str** | | [optional] +**org_id** | **str** | | [optional] + +## Example + +```python +from vectorize_client.models.document import Document + +# TODO update the JSON string below +json = "{}" +# create an instance of Document from a JSON string +document_instance = Document.from_json(json) +# print the JSON string representation of the object +print(Document.to_json()) + +# convert the object into a dict +document_dict = document_instance.to_dict() +# create an instance of Document from a dict +document_from_dict = Document.from_dict(document_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ExtractionChunkingStrategy.md b/docs/ExtractionChunkingStrategy.md new file mode 100644 index 0000000..7eace7c --- /dev/null +++ b/docs/ExtractionChunkingStrategy.md @@ -0,0 +1,10 @@ +# ExtractionChunkingStrategy + + +## Enum + +* `MARKDOWN` (value: `'markdown'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ExtractionResult.md b/docs/ExtractionResult.md new file mode 100644 index 0000000..74fa48c --- /dev/null +++ b/docs/ExtractionResult.md @@ -0,0 +1,36 @@ +# ExtractionResult + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**success** | **bool** | | +**chunks** | **List[str]** | | [optional] +**text** | **str** | | [optional] +**metadata** | **str** | | [optional] +**metadata_schema** | **str** | | [optional] +**chunks_metadata** | **List[str]** | | [optional] +**chunks_schema** | **List[str]** | | [optional] +**error** | **str** | | [optional] + +## Example + +```python +from vectorize_client.models.extraction_result import ExtractionResult + +# TODO update the JSON string below +json = "{}" +# create an instance of ExtractionResult from a JSON string +extraction_result_instance = ExtractionResult.from_json(json) +# print the JSON string representation of the object +print(ExtractionResult.to_json()) + +# convert the object into a dict +extraction_result_dict = extraction_result_instance.to_dict() +# create an instance of ExtractionResult from a dict +extraction_result_from_dict = ExtractionResult.from_dict(extraction_result_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ExtractionResultResponse.md b/docs/ExtractionResultResponse.md new file mode 100644 index 0000000..6fecd57 --- /dev/null +++ b/docs/ExtractionResultResponse.md @@ -0,0 +1,30 @@ +# ExtractionResultResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ready** | **bool** | | +**data** | [**ExtractionResult**](ExtractionResult.md) | | [optional] + +## Example + +```python +from vectorize_client.models.extraction_result_response import ExtractionResultResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of ExtractionResultResponse from a JSON string +extraction_result_response_instance = ExtractionResultResponse.from_json(json) +# print the JSON string representation of the object +print(ExtractionResultResponse.to_json()) + +# convert the object into a dict +extraction_result_response_dict = extraction_result_response_instance.to_dict() +# create an instance of ExtractionResultResponse from a dict +extraction_result_response_from_dict = ExtractionResultResponse.from_dict(extraction_result_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ExtractionType.md b/docs/ExtractionType.md new file mode 100644 index 0000000..56b654e --- /dev/null +++ b/docs/ExtractionType.md @@ -0,0 +1,10 @@ +# ExtractionType + + +## Enum + +* `IRIS` (value: `'iris'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/GetDeepResearchResponse.md b/docs/GetDeepResearchResponse.md new file mode 100644 index 0000000..6d22f6e --- /dev/null +++ b/docs/GetDeepResearchResponse.md @@ -0,0 +1,30 @@ +# GetDeepResearchResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ready** | **bool** | | +**data** | [**DeepResearchResult**](DeepResearchResult.md) | | [optional] + +## Example + +```python +from vectorize_client.models.get_deep_research_response import GetDeepResearchResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of GetDeepResearchResponse from a JSON string +get_deep_research_response_instance = GetDeepResearchResponse.from_json(json) +# print the JSON string representation of the object +print(GetDeepResearchResponse.to_json()) + +# convert the object into a dict +get_deep_research_response_dict = get_deep_research_response_instance.to_dict() +# create an instance of GetDeepResearchResponse from a dict +get_deep_research_response_from_dict = GetDeepResearchResponse.from_dict(get_deep_research_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/GetPipelineEventsResponse.md b/docs/GetPipelineEventsResponse.md new file mode 100644 index 0000000..f738951 --- /dev/null +++ b/docs/GetPipelineEventsResponse.md @@ -0,0 +1,31 @@ +# GetPipelineEventsResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **str** | | +**next_token** | **str** | | [optional] +**data** | [**List[PipelineEvents]**](PipelineEvents.md) | | + +## Example + +```python +from vectorize_client.models.get_pipeline_events_response import GetPipelineEventsResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of GetPipelineEventsResponse from a JSON string +get_pipeline_events_response_instance = GetPipelineEventsResponse.from_json(json) +# print the JSON string representation of the object +print(GetPipelineEventsResponse.to_json()) + +# convert the object into a dict +get_pipeline_events_response_dict = get_pipeline_events_response_instance.to_dict() +# create an instance of GetPipelineEventsResponse from a dict +get_pipeline_events_response_from_dict = GetPipelineEventsResponse.from_dict(get_pipeline_events_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/GetPipelineMetricsResponse.md b/docs/GetPipelineMetricsResponse.md new file mode 100644 index 0000000..663dd4a --- /dev/null +++ b/docs/GetPipelineMetricsResponse.md @@ -0,0 +1,30 @@ +# GetPipelineMetricsResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **str** | | +**data** | [**List[PipelineMetrics]**](PipelineMetrics.md) | | + +## Example + +```python +from vectorize_client.models.get_pipeline_metrics_response import GetPipelineMetricsResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of GetPipelineMetricsResponse from a JSON string +get_pipeline_metrics_response_instance = GetPipelineMetricsResponse.from_json(json) +# print the JSON string representation of the object +print(GetPipelineMetricsResponse.to_json()) + +# convert the object into a dict +get_pipeline_metrics_response_dict = get_pipeline_metrics_response_instance.to_dict() +# create an instance of GetPipelineMetricsResponse from a dict +get_pipeline_metrics_response_from_dict = GetPipelineMetricsResponse.from_dict(get_pipeline_metrics_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/GetPipelineResponse.md b/docs/GetPipelineResponse.md new file mode 100644 index 0000000..f7bdbaa --- /dev/null +++ b/docs/GetPipelineResponse.md @@ -0,0 +1,30 @@ +# GetPipelineResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **str** | | +**data** | [**PipelineSummary**](PipelineSummary.md) | | + +## Example + +```python +from vectorize_client.models.get_pipeline_response import GetPipelineResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of GetPipelineResponse from a JSON string +get_pipeline_response_instance = GetPipelineResponse.from_json(json) +# print the JSON string representation of the object +print(GetPipelineResponse.to_json()) + +# convert the object into a dict +get_pipeline_response_dict = get_pipeline_response_instance.to_dict() +# create an instance of GetPipelineResponse from a dict +get_pipeline_response_from_dict = GetPipelineResponse.from_dict(get_pipeline_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/GetPipelines400Response.md b/docs/GetPipelines400Response.md new file mode 100644 index 0000000..a6bf197 --- /dev/null +++ b/docs/GetPipelines400Response.md @@ -0,0 +1,32 @@ +# GetPipelines400Response + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **str** | | +**details** | **str** | | [optional] +**failed_updates** | **List[str]** | | [optional] +**successful_updates** | **List[str]** | | [optional] + +## Example + +```python +from vectorize_client.models.get_pipelines400_response import GetPipelines400Response + +# TODO update the JSON string below +json = "{}" +# create an instance of GetPipelines400Response from a JSON string +get_pipelines400_response_instance = GetPipelines400Response.from_json(json) +# print the JSON string representation of the object +print(GetPipelines400Response.to_json()) + +# convert the object into a dict +get_pipelines400_response_dict = get_pipelines400_response_instance.to_dict() +# create an instance of GetPipelines400Response from a dict +get_pipelines400_response_from_dict = GetPipelines400Response.from_dict(get_pipelines400_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/GetPipelinesResponse.md b/docs/GetPipelinesResponse.md new file mode 100644 index 0000000..190abaf --- /dev/null +++ b/docs/GetPipelinesResponse.md @@ -0,0 +1,30 @@ +# GetPipelinesResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **str** | | +**data** | [**List[PipelineListSummary]**](PipelineListSummary.md) | | + +## Example + +```python +from vectorize_client.models.get_pipelines_response import GetPipelinesResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of GetPipelinesResponse from a JSON string +get_pipelines_response_instance = GetPipelinesResponse.from_json(json) +# print the JSON string representation of the object +print(GetPipelinesResponse.to_json()) + +# convert the object into a dict +get_pipelines_response_dict = get_pipelines_response_instance.to_dict() +# create an instance of GetPipelinesResponse from a dict +get_pipelines_response_from_dict = GetPipelinesResponse.from_dict(get_pipelines_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/GetUploadFilesResponse.md b/docs/GetUploadFilesResponse.md new file mode 100644 index 0000000..849dcab --- /dev/null +++ b/docs/GetUploadFilesResponse.md @@ -0,0 +1,30 @@ +# GetUploadFilesResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **str** | | +**files** | [**List[UploadFile]**](UploadFile.md) | | + +## Example + +```python +from vectorize_client.models.get_upload_files_response import GetUploadFilesResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of GetUploadFilesResponse from a JSON string +get_upload_files_response_instance = GetUploadFilesResponse.from_json(json) +# print the JSON string representation of the object +print(GetUploadFilesResponse.to_json()) + +# convert the object into a dict +get_upload_files_response_dict = get_upload_files_response_instance.to_dict() +# create an instance of GetUploadFilesResponse from a dict +get_upload_files_response_from_dict = GetUploadFilesResponse.from_dict(get_upload_files_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/MetadataExtractionStrategy.md b/docs/MetadataExtractionStrategy.md new file mode 100644 index 0000000..4cbf77b --- /dev/null +++ b/docs/MetadataExtractionStrategy.md @@ -0,0 +1,30 @@ +# MetadataExtractionStrategy + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**schemas** | [**List[MetadataExtractionStrategySchema]**](MetadataExtractionStrategySchema.md) | | [optional] +**infer_schema** | **bool** | | [optional] + +## Example + +```python +from vectorize_client.models.metadata_extraction_strategy import MetadataExtractionStrategy + +# TODO update the JSON string below +json = "{}" +# create an instance of MetadataExtractionStrategy from a JSON string +metadata_extraction_strategy_instance = MetadataExtractionStrategy.from_json(json) +# print the JSON string representation of the object +print(MetadataExtractionStrategy.to_json()) + +# convert the object into a dict +metadata_extraction_strategy_dict = metadata_extraction_strategy_instance.to_dict() +# create an instance of MetadataExtractionStrategy from a dict +metadata_extraction_strategy_from_dict = MetadataExtractionStrategy.from_dict(metadata_extraction_strategy_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/MetadataExtractionStrategySchema.md b/docs/MetadataExtractionStrategySchema.md new file mode 100644 index 0000000..cb237b3 --- /dev/null +++ b/docs/MetadataExtractionStrategySchema.md @@ -0,0 +1,30 @@ +# MetadataExtractionStrategySchema + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | +**var_schema** | **str** | | + +## Example + +```python +from vectorize_client.models.metadata_extraction_strategy_schema import MetadataExtractionStrategySchema + +# TODO update the JSON string below +json = "{}" +# create an instance of MetadataExtractionStrategySchema from a JSON string +metadata_extraction_strategy_schema_instance = MetadataExtractionStrategySchema.from_json(json) +# print the JSON string representation of the object +print(MetadataExtractionStrategySchema.to_json()) + +# convert the object into a dict +metadata_extraction_strategy_schema_dict = metadata_extraction_strategy_schema_instance.to_dict() +# create an instance of MetadataExtractionStrategySchema from a dict +metadata_extraction_strategy_schema_from_dict = MetadataExtractionStrategySchema.from_dict(metadata_extraction_strategy_schema_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/N8NConfig.md b/docs/N8NConfig.md new file mode 100644 index 0000000..e1d6656 --- /dev/null +++ b/docs/N8NConfig.md @@ -0,0 +1,31 @@ +# N8NConfig + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**account** | **str** | | +**webhook_path** | **str** | | +**headers** | **Dict[str, str]** | | [optional] + +## Example + +```python +from vectorize_client.models.n8_n_config import N8NConfig + +# TODO update the JSON string below +json = "{}" +# create an instance of N8NConfig from a JSON string +n8_n_config_instance = N8NConfig.from_json(json) +# print the JSON string representation of the object +print(N8NConfig.to_json()) + +# convert the object into a dict +n8_n_config_dict = n8_n_config_instance.to_dict() +# create an instance of N8NConfig from a dict +n8_n_config_from_dict = N8NConfig.from_dict(n8_n_config_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/PipelineConfigurationSchema.md b/docs/PipelineConfigurationSchema.md new file mode 100644 index 0000000..2eb22bf --- /dev/null +++ b/docs/PipelineConfigurationSchema.md @@ -0,0 +1,33 @@ +# PipelineConfigurationSchema + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**source_connectors** | [**List[SourceConnectorSchema]**](SourceConnectorSchema.md) | | +**destination_connector** | [**DestinationConnectorSchema**](DestinationConnectorSchema.md) | | +**ai_platform** | [**AIPlatformSchema**](AIPlatformSchema.md) | | +**pipeline_name** | **str** | | +**schedule** | [**ScheduleSchema**](ScheduleSchema.md) | | + +## Example + +```python +from vectorize_client.models.pipeline_configuration_schema import PipelineConfigurationSchema + +# TODO update the JSON string below +json = "{}" +# create an instance of PipelineConfigurationSchema from a JSON string +pipeline_configuration_schema_instance = PipelineConfigurationSchema.from_json(json) +# print the JSON string representation of the object +print(PipelineConfigurationSchema.to_json()) + +# convert the object into a dict +pipeline_configuration_schema_dict = pipeline_configuration_schema_instance.to_dict() +# create an instance of PipelineConfigurationSchema from a dict +pipeline_configuration_schema_from_dict = PipelineConfigurationSchema.from_dict(pipeline_configuration_schema_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/PipelineEvents.md b/docs/PipelineEvents.md new file mode 100644 index 0000000..07eb1fb --- /dev/null +++ b/docs/PipelineEvents.md @@ -0,0 +1,33 @@ +# PipelineEvents + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | +**type** | **str** | | +**timestamp** | **str** | | +**details** | **Dict[str, Optional[object]]** | | [optional] +**summary** | **Dict[str, Optional[object]]** | | [optional] + +## Example + +```python +from vectorize_client.models.pipeline_events import PipelineEvents + +# TODO update the JSON string below +json = "{}" +# create an instance of PipelineEvents from a JSON string +pipeline_events_instance = PipelineEvents.from_json(json) +# print the JSON string representation of the object +print(PipelineEvents.to_json()) + +# convert the object into a dict +pipeline_events_dict = pipeline_events_instance.to_dict() +# create an instance of PipelineEvents from a dict +pipeline_events_from_dict = PipelineEvents.from_dict(pipeline_events_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/PipelineListSummary.md b/docs/PipelineListSummary.md new file mode 100644 index 0000000..5026cf2 --- /dev/null +++ b/docs/PipelineListSummary.md @@ -0,0 +1,41 @@ +# PipelineListSummary + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | +**name** | **str** | | +**document_count** | **float** | | +**source_connector_auth_ids** | **List[str]** | | +**destination_connector_auth_ids** | **List[str]** | | +**ai_platform_auth_ids** | **List[str]** | | +**source_connector_types** | **List[str]** | | +**destination_connector_types** | **List[str]** | | +**ai_platform_types** | **List[str]** | | +**created_at** | **str** | | +**created_by** | **str** | | +**status** | **str** | | [optional] +**config_doc** | **Dict[str, Optional[object]]** | | [optional] + +## Example + +```python +from vectorize_client.models.pipeline_list_summary import PipelineListSummary + +# TODO update the JSON string below +json = "{}" +# create an instance of PipelineListSummary from a JSON string +pipeline_list_summary_instance = PipelineListSummary.from_json(json) +# print the JSON string representation of the object +print(PipelineListSummary.to_json()) + +# convert the object into a dict +pipeline_list_summary_dict = pipeline_list_summary_instance.to_dict() +# create an instance of PipelineListSummary from a dict +pipeline_list_summary_from_dict = PipelineListSummary.from_dict(pipeline_list_summary_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/PipelineMetrics.md b/docs/PipelineMetrics.md new file mode 100644 index 0000000..413e5a3 --- /dev/null +++ b/docs/PipelineMetrics.md @@ -0,0 +1,32 @@ +# PipelineMetrics + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**timestamp** | **str** | | +**new_objects** | **float** | | +**changed_objects** | **float** | | +**deleted_objects** | **float** | | + +## Example + +```python +from vectorize_client.models.pipeline_metrics import PipelineMetrics + +# TODO update the JSON string below +json = "{}" +# create an instance of PipelineMetrics from a JSON string +pipeline_metrics_instance = PipelineMetrics.from_json(json) +# print the JSON string representation of the object +print(PipelineMetrics.to_json()) + +# convert the object into a dict +pipeline_metrics_dict = pipeline_metrics_instance.to_dict() +# create an instance of PipelineMetrics from a dict +pipeline_metrics_from_dict = PipelineMetrics.from_dict(pipeline_metrics_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/PipelineSummary.md b/docs/PipelineSummary.md new file mode 100644 index 0000000..a269f34 --- /dev/null +++ b/docs/PipelineSummary.md @@ -0,0 +1,44 @@ +# PipelineSummary + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | +**name** | **str** | | +**document_count** | **float** | | +**source_connector_auth_ids** | **List[str]** | | +**destination_connector_auth_ids** | **List[str]** | | +**ai_platform_auth_ids** | **List[str]** | | +**source_connector_types** | **List[str]** | | +**destination_connector_types** | **List[str]** | | +**ai_platform_types** | **List[str]** | | +**created_at** | **str** | | +**created_by** | **str** | | +**status** | **str** | | [optional] +**config_doc** | **Dict[str, Optional[object]]** | | [optional] +**source_connectors** | [**List[SourceConnector]**](SourceConnector.md) | | +**destination_connectors** | [**List[DestinationConnector]**](DestinationConnector.md) | | +**ai_platforms** | [**List[AIPlatform]**](AIPlatform.md) | | + +## Example + +```python +from vectorize_client.models.pipeline_summary import PipelineSummary + +# TODO update the JSON string below +json = "{}" +# create an instance of PipelineSummary from a JSON string +pipeline_summary_instance = PipelineSummary.from_json(json) +# print the JSON string representation of the object +print(PipelineSummary.to_json()) + +# convert the object into a dict +pipeline_summary_dict = pipeline_summary_instance.to_dict() +# create an instance of PipelineSummary from a dict +pipeline_summary_from_dict = PipelineSummary.from_dict(pipeline_summary_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/PipelinesApi.md b/docs/PipelinesApi.md new file mode 100644 index 0000000..1a1fcc8 --- /dev/null +++ b/docs/PipelinesApi.md @@ -0,0 +1,175 @@ +# vectorize_client.PipelinesApi + +All URIs are relative to *https://api.vectorize.io/v1* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_pipeline**](PipelinesApi.md#create_pipeline) | **POST** /org/{organization}/pipelines | Create a new source pipeline. Config fields for sources: Amazon S3 (AWS_S3): Check for updates every (seconds) (idle-time): number, Path Prefix (path-prefix): text, Path Metadata Regex (path-metadata-regex): text, Path Regex Group Names (path-regex-group-names): array oftext) | Azure Blob Storage (AZURE_BLOB): Polling Interval (seconds) (idle-time): number, Path Prefix (path-prefix): text, Path Metadata Regex (path-metadata-regex): text, Path Regex Group Names (path-regex-group-names): array oftext) | Confluence (CONFLUENCE): Spaces (spaces): array oftext, Root Parents (root-parents): array oftext) | Discord (DISCORD): Emoji Filter (emoji): array oftext, Author Filter (author): array oftext, Ignore Author Filter (ignore-author): array oftext, Limit (limit): number) | Dropbox (DROPBOX): Read from these folders (optional) (path-prefix): array oftext) | Google Drive OAuth (GOOGLE_DRIVE_OAUTH): Polling Interval (seconds) (idle-time): number) | Google Drive (Service Account) (GOOGLE_DRIVE): Restrict ingest to these folder URLs (optional) (root-parents): array oftext, Polling Interval (seconds) (idle-time): number) | Google Drive Multi-User (Vectorize) (GOOGLE_DRIVE_OAUTH_MULTI): Polling Interval (seconds) (idle-time): number) | Google Drive Multi-User (White Label) (GOOGLE_DRIVE_OAUTH_MULTI_CUSTOM): Polling Interval (seconds) (idle-time): number) | Firecrawl (FIRECRAWL): ) | GCP Cloud Storage (GCS): Check for updates every (seconds) (idle-time): number, Path Prefix (path-prefix): text, Path Metadata Regex (path-metadata-regex): text, Path Regex Group Names (path-regex-group-names): array oftext) | Intercom (INTERCOM): Reindex Interval (seconds) (reindexIntervalSeconds): number, Limit (limit): number, Tags (tags): array oftext) | OneDrive (ONE_DRIVE): Read starting from this folder (optional) (path-prefix): text) | SharePoint (SHAREPOINT): Site Name(s) (sites): array oftext) | Web Crawler (WEB_CRAWLER): Additional Allowed URLs or prefix(es) (allowed-domains-opt): array ofurl, Forbidden Paths (forbidden-paths): array oftext, Throttle (ms) (min-time-between-requests): number, Max Error Count (max-error-count): number, Max URLs (max-urls): number, Max Depth (max-depth): number, Reindex Interval (seconds) (reindex-interval-seconds): number) | File Upload (FILE_UPLOAD): ). Config fields for destinations: Couchbase Capella (CAPELLA): Bucket Name (bucket): text, Scope Name (scope): text, Collection Name (collection): text, Search Index Name (index): text) | DataStax Astra (DATASTAX): Collection Name (collection): text) | Elasticsearch (ELASTIC): Index Name (index): text) | Pinecone (PINECONE): Index Name (index): text, Namespace (namespace): text) | SingleStore (SINGLESTORE): Table Name (table): text) | Milvus (MILVUS): Collection Name (collection): text) | PostgreSQL (POSTGRESQL): Table Name (table): text) | Qdrant (QDRANT): Collection Name (collection): text) | Supabase (SUPABASE): Table Name (table): text) | Weaviate (WEAVIATE): Collection Name (collection): text) | Azure AI Search (AZUREAISEARCH): Index Name (index): text) | Built-in (VECTORIZE): ) | Chroma (CHROMA): Index Name (index): text) | MongoDB (MONGODB): Index Name (index): text). Config fields for AI platforms: +[**get_pipelines**](PipelinesApi.md#get_pipelines) | **GET** /org/{organization}/pipelines | Get all existing pipelines + + +# **create_pipeline** +> CreatePipelineResponse create_pipeline(organization, pipeline_configuration_schema) + +Create a new source pipeline. Config fields for sources: Amazon S3 (AWS_S3): Check for updates every (seconds) (idle-time): number, Path Prefix (path-prefix): text, Path Metadata Regex (path-metadata-regex): text, Path Regex Group Names (path-regex-group-names): array oftext) | Azure Blob Storage (AZURE_BLOB): Polling Interval (seconds) (idle-time): number, Path Prefix (path-prefix): text, Path Metadata Regex (path-metadata-regex): text, Path Regex Group Names (path-regex-group-names): array oftext) | Confluence (CONFLUENCE): Spaces (spaces): array oftext, Root Parents (root-parents): array oftext) | Discord (DISCORD): Emoji Filter (emoji): array oftext, Author Filter (author): array oftext, Ignore Author Filter (ignore-author): array oftext, Limit (limit): number) | Dropbox (DROPBOX): Read from these folders (optional) (path-prefix): array oftext) | Google Drive OAuth (GOOGLE_DRIVE_OAUTH): Polling Interval (seconds) (idle-time): number) | Google Drive (Service Account) (GOOGLE_DRIVE): Restrict ingest to these folder URLs (optional) (root-parents): array oftext, Polling Interval (seconds) (idle-time): number) | Google Drive Multi-User (Vectorize) (GOOGLE_DRIVE_OAUTH_MULTI): Polling Interval (seconds) (idle-time): number) | Google Drive Multi-User (White Label) (GOOGLE_DRIVE_OAUTH_MULTI_CUSTOM): Polling Interval (seconds) (idle-time): number) | Firecrawl (FIRECRAWL): ) | GCP Cloud Storage (GCS): Check for updates every (seconds) (idle-time): number, Path Prefix (path-prefix): text, Path Metadata Regex (path-metadata-regex): text, Path Regex Group Names (path-regex-group-names): array oftext) | Intercom (INTERCOM): Reindex Interval (seconds) (reindexIntervalSeconds): number, Limit (limit): number, Tags (tags): array oftext) | OneDrive (ONE_DRIVE): Read starting from this folder (optional) (path-prefix): text) | SharePoint (SHAREPOINT): Site Name(s) (sites): array oftext) | Web Crawler (WEB_CRAWLER): Additional Allowed URLs or prefix(es) (allowed-domains-opt): array ofurl, Forbidden Paths (forbidden-paths): array oftext, Throttle (ms) (min-time-between-requests): number, Max Error Count (max-error-count): number, Max URLs (max-urls): number, Max Depth (max-depth): number, Reindex Interval (seconds) (reindex-interval-seconds): number) | File Upload (FILE_UPLOAD): ). Config fields for destinations: Couchbase Capella (CAPELLA): Bucket Name (bucket): text, Scope Name (scope): text, Collection Name (collection): text, Search Index Name (index): text) | DataStax Astra (DATASTAX): Collection Name (collection): text) | Elasticsearch (ELASTIC): Index Name (index): text) | Pinecone (PINECONE): Index Name (index): text, Namespace (namespace): text) | SingleStore (SINGLESTORE): Table Name (table): text) | Milvus (MILVUS): Collection Name (collection): text) | PostgreSQL (POSTGRESQL): Table Name (table): text) | Qdrant (QDRANT): Collection Name (collection): text) | Supabase (SUPABASE): Table Name (table): text) | Weaviate (WEAVIATE): Collection Name (collection): text) | Azure AI Search (AZUREAISEARCH): Index Name (index): text) | Built-in (VECTORIZE): ) | Chroma (CHROMA): Index Name (index): text) | MongoDB (MONGODB): Index Name (index): text). Config fields for AI platforms: + +### Example + +* Bearer (JWT) Authentication (bearerAuth): + +```python +import vectorize_client +from vectorize_client.models.create_pipeline_response import CreatePipelineResponse +from vectorize_client.models.pipeline_configuration_schema import PipelineConfigurationSchema +from vectorize_client.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://api.vectorize.io/v1 +# See configuration.py for a list of all supported configuration parameters. +configuration = vectorize_client.Configuration( + host = "https://api.vectorize.io/v1" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure Bearer authorization (JWT): bearerAuth +configuration = vectorize_client.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + +# Enter a context with an instance of the API client +with vectorize_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = vectorize_client.PipelinesApi(api_client) + organization = 'organization_example' # str | + pipeline_configuration_schema = vectorize_client.PipelineConfigurationSchema() # PipelineConfigurationSchema | + + try: + # Create a new source pipeline. Config fields for sources: Amazon S3 (AWS_S3): Check for updates every (seconds) (idle-time): number, Path Prefix (path-prefix): text, Path Metadata Regex (path-metadata-regex): text, Path Regex Group Names (path-regex-group-names): array oftext) | Azure Blob Storage (AZURE_BLOB): Polling Interval (seconds) (idle-time): number, Path Prefix (path-prefix): text, Path Metadata Regex (path-metadata-regex): text, Path Regex Group Names (path-regex-group-names): array oftext) | Confluence (CONFLUENCE): Spaces (spaces): array oftext, Root Parents (root-parents): array oftext) | Discord (DISCORD): Emoji Filter (emoji): array oftext, Author Filter (author): array oftext, Ignore Author Filter (ignore-author): array oftext, Limit (limit): number) | Dropbox (DROPBOX): Read from these folders (optional) (path-prefix): array oftext) | Google Drive OAuth (GOOGLE_DRIVE_OAUTH): Polling Interval (seconds) (idle-time): number) | Google Drive (Service Account) (GOOGLE_DRIVE): Restrict ingest to these folder URLs (optional) (root-parents): array oftext, Polling Interval (seconds) (idle-time): number) | Google Drive Multi-User (Vectorize) (GOOGLE_DRIVE_OAUTH_MULTI): Polling Interval (seconds) (idle-time): number) | Google Drive Multi-User (White Label) (GOOGLE_DRIVE_OAUTH_MULTI_CUSTOM): Polling Interval (seconds) (idle-time): number) | Firecrawl (FIRECRAWL): ) | GCP Cloud Storage (GCS): Check for updates every (seconds) (idle-time): number, Path Prefix (path-prefix): text, Path Metadata Regex (path-metadata-regex): text, Path Regex Group Names (path-regex-group-names): array oftext) | Intercom (INTERCOM): Reindex Interval (seconds) (reindexIntervalSeconds): number, Limit (limit): number, Tags (tags): array oftext) | OneDrive (ONE_DRIVE): Read starting from this folder (optional) (path-prefix): text) | SharePoint (SHAREPOINT): Site Name(s) (sites): array oftext) | Web Crawler (WEB_CRAWLER): Additional Allowed URLs or prefix(es) (allowed-domains-opt): array ofurl, Forbidden Paths (forbidden-paths): array oftext, Throttle (ms) (min-time-between-requests): number, Max Error Count (max-error-count): number, Max URLs (max-urls): number, Max Depth (max-depth): number, Reindex Interval (seconds) (reindex-interval-seconds): number) | File Upload (FILE_UPLOAD): ). Config fields for destinations: Couchbase Capella (CAPELLA): Bucket Name (bucket): text, Scope Name (scope): text, Collection Name (collection): text, Search Index Name (index): text) | DataStax Astra (DATASTAX): Collection Name (collection): text) | Elasticsearch (ELASTIC): Index Name (index): text) | Pinecone (PINECONE): Index Name (index): text, Namespace (namespace): text) | SingleStore (SINGLESTORE): Table Name (table): text) | Milvus (MILVUS): Collection Name (collection): text) | PostgreSQL (POSTGRESQL): Table Name (table): text) | Qdrant (QDRANT): Collection Name (collection): text) | Supabase (SUPABASE): Table Name (table): text) | Weaviate (WEAVIATE): Collection Name (collection): text) | Azure AI Search (AZUREAISEARCH): Index Name (index): text) | Built-in (VECTORIZE): ) | Chroma (CHROMA): Index Name (index): text) | MongoDB (MONGODB): Index Name (index): text). Config fields for AI platforms: + api_response = api_instance.create_pipeline(organization, pipeline_configuration_schema) + print("The response of PipelinesApi->create_pipeline:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PipelinesApi->create_pipeline: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organization** | **str**| | + **pipeline_configuration_schema** | [**PipelineConfigurationSchema**](PipelineConfigurationSchema.md)| | + +### Return type + +[**CreatePipelineResponse**](CreatePipelineResponse.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Pipeline created successfully | - | +**400** | Invalid request | - | +**401** | Unauthorized | - | +**403** | Forbidden | - | +**404** | Not found | - | +**500** | Internal server error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_pipelines** +> GetPipelinesResponse get_pipelines(organization) + +Get all existing pipelines + +### Example + +* Bearer (JWT) Authentication (bearerAuth): + +```python +import vectorize_client +from vectorize_client.models.get_pipelines_response import GetPipelinesResponse +from vectorize_client.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://api.vectorize.io/v1 +# See configuration.py for a list of all supported configuration parameters. +configuration = vectorize_client.Configuration( + host = "https://api.vectorize.io/v1" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure Bearer authorization (JWT): bearerAuth +configuration = vectorize_client.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + +# Enter a context with an instance of the API client +with vectorize_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = vectorize_client.PipelinesApi(api_client) + organization = 'organization_example' # str | + + try: + # Get all existing pipelines + api_response = api_instance.get_pipelines(organization) + print("The response of PipelinesApi->get_pipelines:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PipelinesApi->get_pipelines: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organization** | **str**| | + +### Return type + +[**GetPipelinesResponse**](GetPipelinesResponse.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Get all pipelines | - | +**400** | Invalid request | - | +**401** | Unauthorized | - | +**403** | Forbidden | - | +**404** | Not found | - | +**500** | Internal server error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/RemoveUserFromSourceConnectorRequest.md b/docs/RemoveUserFromSourceConnectorRequest.md new file mode 100644 index 0000000..a34c16a --- /dev/null +++ b/docs/RemoveUserFromSourceConnectorRequest.md @@ -0,0 +1,29 @@ +# RemoveUserFromSourceConnectorRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**user_id** | **str** | | + +## Example + +```python +from vectorize_client.models.remove_user_from_source_connector_request import RemoveUserFromSourceConnectorRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of RemoveUserFromSourceConnectorRequest from a JSON string +remove_user_from_source_connector_request_instance = RemoveUserFromSourceConnectorRequest.from_json(json) +# print the JSON string representation of the object +print(RemoveUserFromSourceConnectorRequest.to_json()) + +# convert the object into a dict +remove_user_from_source_connector_request_dict = remove_user_from_source_connector_request_instance.to_dict() +# create an instance of RemoveUserFromSourceConnectorRequest from a dict +remove_user_from_source_connector_request_from_dict = RemoveUserFromSourceConnectorRequest.from_dict(remove_user_from_source_connector_request_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/RemoveUserFromSourceConnectorResponse.md b/docs/RemoveUserFromSourceConnectorResponse.md new file mode 100644 index 0000000..74de0f4 --- /dev/null +++ b/docs/RemoveUserFromSourceConnectorResponse.md @@ -0,0 +1,29 @@ +# RemoveUserFromSourceConnectorResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **str** | | + +## Example + +```python +from vectorize_client.models.remove_user_from_source_connector_response import RemoveUserFromSourceConnectorResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of RemoveUserFromSourceConnectorResponse from a JSON string +remove_user_from_source_connector_response_instance = RemoveUserFromSourceConnectorResponse.from_json(json) +# print the JSON string representation of the object +print(RemoveUserFromSourceConnectorResponse.to_json()) + +# convert the object into a dict +remove_user_from_source_connector_response_dict = remove_user_from_source_connector_response_instance.to_dict() +# create an instance of RemoveUserFromSourceConnectorResponse from a dict +remove_user_from_source_connector_response_from_dict = RemoveUserFromSourceConnectorResponse.from_dict(remove_user_from_source_connector_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/RetrieveContext.md b/docs/RetrieveContext.md new file mode 100644 index 0000000..30be06c --- /dev/null +++ b/docs/RetrieveContext.md @@ -0,0 +1,29 @@ +# RetrieveContext + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**messages** | [**List[RetrieveContextMessage]**](RetrieveContextMessage.md) | | + +## Example + +```python +from vectorize_client.models.retrieve_context import RetrieveContext + +# TODO update the JSON string below +json = "{}" +# create an instance of RetrieveContext from a JSON string +retrieve_context_instance = RetrieveContext.from_json(json) +# print the JSON string representation of the object +print(RetrieveContext.to_json()) + +# convert the object into a dict +retrieve_context_dict = retrieve_context_instance.to_dict() +# create an instance of RetrieveContext from a dict +retrieve_context_from_dict = RetrieveContext.from_dict(retrieve_context_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/RetrieveContextMessage.md b/docs/RetrieveContextMessage.md new file mode 100644 index 0000000..8f2c6ac --- /dev/null +++ b/docs/RetrieveContextMessage.md @@ -0,0 +1,30 @@ +# RetrieveContextMessage + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**role** | **str** | | +**content** | **str** | | + +## Example + +```python +from vectorize_client.models.retrieve_context_message import RetrieveContextMessage + +# TODO update the JSON string below +json = "{}" +# create an instance of RetrieveContextMessage from a JSON string +retrieve_context_message_instance = RetrieveContextMessage.from_json(json) +# print the JSON string representation of the object +print(RetrieveContextMessage.to_json()) + +# convert the object into a dict +retrieve_context_message_dict = retrieve_context_message_instance.to_dict() +# create an instance of RetrieveContextMessage from a dict +retrieve_context_message_from_dict = RetrieveContextMessage.from_dict(retrieve_context_message_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/RetrieveDocumentsRequest.md b/docs/RetrieveDocumentsRequest.md new file mode 100644 index 0000000..392856b --- /dev/null +++ b/docs/RetrieveDocumentsRequest.md @@ -0,0 +1,34 @@ +# RetrieveDocumentsRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**question** | **str** | | +**num_results** | **float** | | +**rerank** | **bool** | | [optional] [default to True] +**metadata_filters** | **List[Dict[str, Optional[object]]]** | | [optional] +**context** | [**RetrieveContext**](RetrieveContext.md) | | [optional] +**advanced_query** | [**AdvancedQuery**](AdvancedQuery.md) | | [optional] + +## Example + +```python +from vectorize_client.models.retrieve_documents_request import RetrieveDocumentsRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of RetrieveDocumentsRequest from a JSON string +retrieve_documents_request_instance = RetrieveDocumentsRequest.from_json(json) +# print the JSON string representation of the object +print(RetrieveDocumentsRequest.to_json()) + +# convert the object into a dict +retrieve_documents_request_dict = retrieve_documents_request_instance.to_dict() +# create an instance of RetrieveDocumentsRequest from a dict +retrieve_documents_request_from_dict = RetrieveDocumentsRequest.from_dict(retrieve_documents_request_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/RetrieveDocumentsResponse.md b/docs/RetrieveDocumentsResponse.md new file mode 100644 index 0000000..75c2951 --- /dev/null +++ b/docs/RetrieveDocumentsResponse.md @@ -0,0 +1,32 @@ +# RetrieveDocumentsResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**question** | **str** | | +**documents** | [**List[Document]**](Document.md) | | +**average_relevancy** | **float** | | +**ndcg** | **float** | | + +## Example + +```python +from vectorize_client.models.retrieve_documents_response import RetrieveDocumentsResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of RetrieveDocumentsResponse from a JSON string +retrieve_documents_response_instance = RetrieveDocumentsResponse.from_json(json) +# print the JSON string representation of the object +print(RetrieveDocumentsResponse.to_json()) + +# convert the object into a dict +retrieve_documents_response_dict = retrieve_documents_response_instance.to_dict() +# create an instance of RetrieveDocumentsResponse from a dict +retrieve_documents_response_from_dict = RetrieveDocumentsResponse.from_dict(retrieve_documents_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ScheduleSchema.md b/docs/ScheduleSchema.md new file mode 100644 index 0000000..7a8f93b --- /dev/null +++ b/docs/ScheduleSchema.md @@ -0,0 +1,29 @@ +# ScheduleSchema + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | [**ScheduleSchemaType**](ScheduleSchemaType.md) | | + +## Example + +```python +from vectorize_client.models.schedule_schema import ScheduleSchema + +# TODO update the JSON string below +json = "{}" +# create an instance of ScheduleSchema from a JSON string +schedule_schema_instance = ScheduleSchema.from_json(json) +# print the JSON string representation of the object +print(ScheduleSchema.to_json()) + +# convert the object into a dict +schedule_schema_dict = schedule_schema_instance.to_dict() +# create an instance of ScheduleSchema from a dict +schedule_schema_from_dict = ScheduleSchema.from_dict(schedule_schema_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ScheduleSchemaType.md b/docs/ScheduleSchemaType.md new file mode 100644 index 0000000..3da057e --- /dev/null +++ b/docs/ScheduleSchemaType.md @@ -0,0 +1,14 @@ +# ScheduleSchemaType + + +## Enum + +* `MANUAL` (value: `'manual'`) + +* `REALTIME` (value: `'realtime'`) + +* `CUSTOM` (value: `'custom'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/SourceConnector.md b/docs/SourceConnector.md new file mode 100644 index 0000000..295d952 --- /dev/null +++ b/docs/SourceConnector.md @@ -0,0 +1,39 @@ +# SourceConnector + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | +**type** | **str** | | +**name** | **str** | | +**config_doc** | **Dict[str, Optional[object]]** | | [optional] +**created_at** | **str** | | [optional] +**created_by_id** | **str** | | [optional] +**last_updated_by_id** | **str** | | [optional] +**created_by_email** | **str** | | [optional] +**last_updated_by_email** | **str** | | [optional] +**error_message** | **str** | | [optional] +**verification_status** | **str** | | [optional] + +## Example + +```python +from vectorize_client.models.source_connector import SourceConnector + +# TODO update the JSON string below +json = "{}" +# create an instance of SourceConnector from a JSON string +source_connector_instance = SourceConnector.from_json(json) +# print the JSON string representation of the object +print(SourceConnector.to_json()) + +# convert the object into a dict +source_connector_dict = source_connector_instance.to_dict() +# create an instance of SourceConnector from a dict +source_connector_from_dict = SourceConnector.from_dict(source_connector_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/SourceConnectorSchema.md b/docs/SourceConnectorSchema.md new file mode 100644 index 0000000..a0d73bd --- /dev/null +++ b/docs/SourceConnectorSchema.md @@ -0,0 +1,31 @@ +# SourceConnectorSchema + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | +**type** | [**SourceConnectorType**](SourceConnectorType.md) | | +**config** | **Dict[str, Optional[object]]** | | [optional] + +## Example + +```python +from vectorize_client.models.source_connector_schema import SourceConnectorSchema + +# TODO update the JSON string below +json = "{}" +# create an instance of SourceConnectorSchema from a JSON string +source_connector_schema_instance = SourceConnectorSchema.from_json(json) +# print the JSON string representation of the object +print(SourceConnectorSchema.to_json()) + +# convert the object into a dict +source_connector_schema_dict = source_connector_schema_instance.to_dict() +# create an instance of SourceConnectorSchema from a dict +source_connector_schema_from_dict = SourceConnectorSchema.from_dict(source_connector_schema_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/SourceConnectorType.md b/docs/SourceConnectorType.md new file mode 100644 index 0000000..9e9e3b8 --- /dev/null +++ b/docs/SourceConnectorType.md @@ -0,0 +1,44 @@ +# SourceConnectorType + + +## Enum + +* `AWS_S3` (value: `'AWS_S3'`) + +* `AZURE_BLOB` (value: `'AZURE_BLOB'`) + +* `CONFLUENCE` (value: `'CONFLUENCE'`) + +* `DISCORD` (value: `'DISCORD'`) + +* `DROPBOX` (value: `'DROPBOX'`) + +* `GOOGLE_DRIVE_OAUTH` (value: `'GOOGLE_DRIVE_OAUTH'`) + +* `GOOGLE_DRIVE` (value: `'GOOGLE_DRIVE'`) + +* `GOOGLE_DRIVE_OAUTH_MULTI` (value: `'GOOGLE_DRIVE_OAUTH_MULTI'`) + +* `GOOGLE_DRIVE_OAUTH_MULTI_CUSTOM` (value: `'GOOGLE_DRIVE_OAUTH_MULTI_CUSTOM'`) + +* `FIRECRAWL` (value: `'FIRECRAWL'`) + +* `GCS` (value: `'GCS'`) + +* `INTERCOM` (value: `'INTERCOM'`) + +* `ONE_DRIVE` (value: `'ONE_DRIVE'`) + +* `SHAREPOINT` (value: `'SHAREPOINT'`) + +* `WEB_CRAWLER` (value: `'WEB_CRAWLER'`) + +* `FILE_UPLOAD` (value: `'FILE_UPLOAD'`) + +* `SALESFORCE` (value: `'SALESFORCE'`) + +* `ZENDESK` (value: `'ZENDESK'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/StartDeepResearchRequest.md b/docs/StartDeepResearchRequest.md new file mode 100644 index 0000000..918c347 --- /dev/null +++ b/docs/StartDeepResearchRequest.md @@ -0,0 +1,32 @@ +# StartDeepResearchRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**query** | **str** | | +**web_search** | **bool** | | [optional] [default to False] +**var_schema** | **str** | | [optional] +**n8n** | [**N8NConfig**](N8NConfig.md) | | [optional] + +## Example + +```python +from vectorize_client.models.start_deep_research_request import StartDeepResearchRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of StartDeepResearchRequest from a JSON string +start_deep_research_request_instance = StartDeepResearchRequest.from_json(json) +# print the JSON string representation of the object +print(StartDeepResearchRequest.to_json()) + +# convert the object into a dict +start_deep_research_request_dict = start_deep_research_request_instance.to_dict() +# create an instance of StartDeepResearchRequest from a dict +start_deep_research_request_from_dict = StartDeepResearchRequest.from_dict(start_deep_research_request_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/StartDeepResearchResponse.md b/docs/StartDeepResearchResponse.md new file mode 100644 index 0000000..7130a15 --- /dev/null +++ b/docs/StartDeepResearchResponse.md @@ -0,0 +1,29 @@ +# StartDeepResearchResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**research_id** | **str** | | + +## Example + +```python +from vectorize_client.models.start_deep_research_response import StartDeepResearchResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of StartDeepResearchResponse from a JSON string +start_deep_research_response_instance = StartDeepResearchResponse.from_json(json) +# print the JSON string representation of the object +print(StartDeepResearchResponse.to_json()) + +# convert the object into a dict +start_deep_research_response_dict = start_deep_research_response_instance.to_dict() +# create an instance of StartDeepResearchResponse from a dict +start_deep_research_response_from_dict = StartDeepResearchResponse.from_dict(start_deep_research_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/StartExtractionRequest.md b/docs/StartExtractionRequest.md new file mode 100644 index 0000000..237b1d3 --- /dev/null +++ b/docs/StartExtractionRequest.md @@ -0,0 +1,33 @@ +# StartExtractionRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**file_id** | **str** | | +**type** | [**ExtractionType**](ExtractionType.md) | | [optional] [default to ExtractionType.IRIS] +**chunking_strategy** | [**ExtractionChunkingStrategy**](ExtractionChunkingStrategy.md) | | [optional] [default to ExtractionChunkingStrategy.MARKDOWN] +**chunk_size** | **float** | | [optional] [default to 256] +**metadata** | [**MetadataExtractionStrategy**](MetadataExtractionStrategy.md) | | [optional] + +## Example + +```python +from vectorize_client.models.start_extraction_request import StartExtractionRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of StartExtractionRequest from a JSON string +start_extraction_request_instance = StartExtractionRequest.from_json(json) +# print the JSON string representation of the object +print(StartExtractionRequest.to_json()) + +# convert the object into a dict +start_extraction_request_dict = start_extraction_request_instance.to_dict() +# create an instance of StartExtractionRequest from a dict +start_extraction_request_from_dict = StartExtractionRequest.from_dict(start_extraction_request_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/StartExtractionResponse.md b/docs/StartExtractionResponse.md new file mode 100644 index 0000000..72aeeed --- /dev/null +++ b/docs/StartExtractionResponse.md @@ -0,0 +1,30 @@ +# StartExtractionResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **str** | | +**extraction_id** | **str** | | + +## Example + +```python +from vectorize_client.models.start_extraction_response import StartExtractionResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of StartExtractionResponse from a JSON string +start_extraction_response_instance = StartExtractionResponse.from_json(json) +# print the JSON string representation of the object +print(StartExtractionResponse.to_json()) + +# convert the object into a dict +start_extraction_response_dict = start_extraction_response_instance.to_dict() +# create an instance of StartExtractionResponse from a dict +start_extraction_response_from_dict = StartExtractionResponse.from_dict(start_extraction_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/StartFileUploadRequest.md b/docs/StartFileUploadRequest.md new file mode 100644 index 0000000..221e641 --- /dev/null +++ b/docs/StartFileUploadRequest.md @@ -0,0 +1,30 @@ +# StartFileUploadRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | | +**content_type** | **str** | | + +## Example + +```python +from vectorize_client.models.start_file_upload_request import StartFileUploadRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of StartFileUploadRequest from a JSON string +start_file_upload_request_instance = StartFileUploadRequest.from_json(json) +# print the JSON string representation of the object +print(StartFileUploadRequest.to_json()) + +# convert the object into a dict +start_file_upload_request_dict = start_file_upload_request_instance.to_dict() +# create an instance of StartFileUploadRequest from a dict +start_file_upload_request_from_dict = StartFileUploadRequest.from_dict(start_file_upload_request_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/StartFileUploadResponse.md b/docs/StartFileUploadResponse.md new file mode 100644 index 0000000..d321ab2 --- /dev/null +++ b/docs/StartFileUploadResponse.md @@ -0,0 +1,30 @@ +# StartFileUploadResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**file_id** | **str** | | +**upload_url** | **str** | | + +## Example + +```python +from vectorize_client.models.start_file_upload_response import StartFileUploadResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of StartFileUploadResponse from a JSON string +start_file_upload_response_instance = StartFileUploadResponse.from_json(json) +# print the JSON string representation of the object +print(StartFileUploadResponse.to_json()) + +# convert the object into a dict +start_file_upload_response_dict = start_file_upload_response_instance.to_dict() +# create an instance of StartFileUploadResponse from a dict +start_file_upload_response_from_dict = StartFileUploadResponse.from_dict(start_file_upload_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/StartFileUploadToConnectorRequest.md b/docs/StartFileUploadToConnectorRequest.md new file mode 100644 index 0000000..f6da191 --- /dev/null +++ b/docs/StartFileUploadToConnectorRequest.md @@ -0,0 +1,31 @@ +# StartFileUploadToConnectorRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | | +**content_type** | **str** | | +**metadata** | **str** | | [optional] + +## Example + +```python +from vectorize_client.models.start_file_upload_to_connector_request import StartFileUploadToConnectorRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of StartFileUploadToConnectorRequest from a JSON string +start_file_upload_to_connector_request_instance = StartFileUploadToConnectorRequest.from_json(json) +# print the JSON string representation of the object +print(StartFileUploadToConnectorRequest.to_json()) + +# convert the object into a dict +start_file_upload_to_connector_request_dict = start_file_upload_to_connector_request_instance.to_dict() +# create an instance of StartFileUploadToConnectorRequest from a dict +start_file_upload_to_connector_request_from_dict = StartFileUploadToConnectorRequest.from_dict(start_file_upload_to_connector_request_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/StartFileUploadToConnectorResponse.md b/docs/StartFileUploadToConnectorResponse.md new file mode 100644 index 0000000..62a380f --- /dev/null +++ b/docs/StartFileUploadToConnectorResponse.md @@ -0,0 +1,29 @@ +# StartFileUploadToConnectorResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**upload_url** | **str** | | + +## Example + +```python +from vectorize_client.models.start_file_upload_to_connector_response import StartFileUploadToConnectorResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of StartFileUploadToConnectorResponse from a JSON string +start_file_upload_to_connector_response_instance = StartFileUploadToConnectorResponse.from_json(json) +# print the JSON string representation of the object +print(StartFileUploadToConnectorResponse.to_json()) + +# convert the object into a dict +start_file_upload_to_connector_response_dict = start_file_upload_to_connector_response_instance.to_dict() +# create an instance of StartFileUploadToConnectorResponse from a dict +start_file_upload_to_connector_response_from_dict = StartFileUploadToConnectorResponse.from_dict(start_file_upload_to_connector_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/StartPipelineResponse.md b/docs/StartPipelineResponse.md new file mode 100644 index 0000000..d70222b --- /dev/null +++ b/docs/StartPipelineResponse.md @@ -0,0 +1,29 @@ +# StartPipelineResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **str** | | + +## Example + +```python +from vectorize_client.models.start_pipeline_response import StartPipelineResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of StartPipelineResponse from a JSON string +start_pipeline_response_instance = StartPipelineResponse.from_json(json) +# print the JSON string representation of the object +print(StartPipelineResponse.to_json()) + +# convert the object into a dict +start_pipeline_response_dict = start_pipeline_response_instance.to_dict() +# create an instance of StartPipelineResponse from a dict +start_pipeline_response_from_dict = StartPipelineResponse.from_dict(start_pipeline_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/StopPipelineResponse.md b/docs/StopPipelineResponse.md new file mode 100644 index 0000000..0917c99 --- /dev/null +++ b/docs/StopPipelineResponse.md @@ -0,0 +1,29 @@ +# StopPipelineResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **str** | | + +## Example + +```python +from vectorize_client.models.stop_pipeline_response import StopPipelineResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of StopPipelineResponse from a JSON string +stop_pipeline_response_instance = StopPipelineResponse.from_json(json) +# print the JSON string representation of the object +print(StopPipelineResponse.to_json()) + +# convert the object into a dict +stop_pipeline_response_dict = stop_pipeline_response_instance.to_dict() +# create an instance of StopPipelineResponse from a dict +stop_pipeline_response_from_dict = StopPipelineResponse.from_dict(stop_pipeline_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/UpdateAIPlatformConnectorRequest.md b/docs/UpdateAIPlatformConnectorRequest.md new file mode 100644 index 0000000..f08dbae --- /dev/null +++ b/docs/UpdateAIPlatformConnectorRequest.md @@ -0,0 +1,29 @@ +# UpdateAIPlatformConnectorRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**config** | **Dict[str, Optional[object]]** | | + +## Example + +```python +from vectorize_client.models.update_ai_platform_connector_request import UpdateAIPlatformConnectorRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of UpdateAIPlatformConnectorRequest from a JSON string +update_ai_platform_connector_request_instance = UpdateAIPlatformConnectorRequest.from_json(json) +# print the JSON string representation of the object +print(UpdateAIPlatformConnectorRequest.to_json()) + +# convert the object into a dict +update_ai_platform_connector_request_dict = update_ai_platform_connector_request_instance.to_dict() +# create an instance of UpdateAIPlatformConnectorRequest from a dict +update_ai_platform_connector_request_from_dict = UpdateAIPlatformConnectorRequest.from_dict(update_ai_platform_connector_request_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/UpdateAIPlatformConnectorResponse.md b/docs/UpdateAIPlatformConnectorResponse.md new file mode 100644 index 0000000..5209503 --- /dev/null +++ b/docs/UpdateAIPlatformConnectorResponse.md @@ -0,0 +1,30 @@ +# UpdateAIPlatformConnectorResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **str** | | +**data** | [**UpdatedAIPlatformConnectorData**](UpdatedAIPlatformConnectorData.md) | | + +## Example + +```python +from vectorize_client.models.update_ai_platform_connector_response import UpdateAIPlatformConnectorResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of UpdateAIPlatformConnectorResponse from a JSON string +update_ai_platform_connector_response_instance = UpdateAIPlatformConnectorResponse.from_json(json) +# print the JSON string representation of the object +print(UpdateAIPlatformConnectorResponse.to_json()) + +# convert the object into a dict +update_ai_platform_connector_response_dict = update_ai_platform_connector_response_instance.to_dict() +# create an instance of UpdateAIPlatformConnectorResponse from a dict +update_ai_platform_connector_response_from_dict = UpdateAIPlatformConnectorResponse.from_dict(update_ai_platform_connector_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/UpdateDestinationConnectorRequest.md b/docs/UpdateDestinationConnectorRequest.md new file mode 100644 index 0000000..f7f02a6 --- /dev/null +++ b/docs/UpdateDestinationConnectorRequest.md @@ -0,0 +1,29 @@ +# UpdateDestinationConnectorRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**config** | **Dict[str, Optional[object]]** | | + +## Example + +```python +from vectorize_client.models.update_destination_connector_request import UpdateDestinationConnectorRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of UpdateDestinationConnectorRequest from a JSON string +update_destination_connector_request_instance = UpdateDestinationConnectorRequest.from_json(json) +# print the JSON string representation of the object +print(UpdateDestinationConnectorRequest.to_json()) + +# convert the object into a dict +update_destination_connector_request_dict = update_destination_connector_request_instance.to_dict() +# create an instance of UpdateDestinationConnectorRequest from a dict +update_destination_connector_request_from_dict = UpdateDestinationConnectorRequest.from_dict(update_destination_connector_request_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/UpdateDestinationConnectorResponse.md b/docs/UpdateDestinationConnectorResponse.md new file mode 100644 index 0000000..58c1725 --- /dev/null +++ b/docs/UpdateDestinationConnectorResponse.md @@ -0,0 +1,30 @@ +# UpdateDestinationConnectorResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **str** | | +**data** | [**UpdatedDestinationConnectorData**](UpdatedDestinationConnectorData.md) | | + +## Example + +```python +from vectorize_client.models.update_destination_connector_response import UpdateDestinationConnectorResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of UpdateDestinationConnectorResponse from a JSON string +update_destination_connector_response_instance = UpdateDestinationConnectorResponse.from_json(json) +# print the JSON string representation of the object +print(UpdateDestinationConnectorResponse.to_json()) + +# convert the object into a dict +update_destination_connector_response_dict = update_destination_connector_response_instance.to_dict() +# create an instance of UpdateDestinationConnectorResponse from a dict +update_destination_connector_response_from_dict = UpdateDestinationConnectorResponse.from_dict(update_destination_connector_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/UpdateSourceConnectorRequest.md b/docs/UpdateSourceConnectorRequest.md new file mode 100644 index 0000000..a32470f --- /dev/null +++ b/docs/UpdateSourceConnectorRequest.md @@ -0,0 +1,29 @@ +# UpdateSourceConnectorRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**config** | **Dict[str, Optional[object]]** | | + +## Example + +```python +from vectorize_client.models.update_source_connector_request import UpdateSourceConnectorRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of UpdateSourceConnectorRequest from a JSON string +update_source_connector_request_instance = UpdateSourceConnectorRequest.from_json(json) +# print the JSON string representation of the object +print(UpdateSourceConnectorRequest.to_json()) + +# convert the object into a dict +update_source_connector_request_dict = update_source_connector_request_instance.to_dict() +# create an instance of UpdateSourceConnectorRequest from a dict +update_source_connector_request_from_dict = UpdateSourceConnectorRequest.from_dict(update_source_connector_request_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/UpdateSourceConnectorResponse.md b/docs/UpdateSourceConnectorResponse.md new file mode 100644 index 0000000..2cb49dc --- /dev/null +++ b/docs/UpdateSourceConnectorResponse.md @@ -0,0 +1,30 @@ +# UpdateSourceConnectorResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **str** | | +**data** | [**UpdateSourceConnectorResponseData**](UpdateSourceConnectorResponseData.md) | | + +## Example + +```python +from vectorize_client.models.update_source_connector_response import UpdateSourceConnectorResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of UpdateSourceConnectorResponse from a JSON string +update_source_connector_response_instance = UpdateSourceConnectorResponse.from_json(json) +# print the JSON string representation of the object +print(UpdateSourceConnectorResponse.to_json()) + +# convert the object into a dict +update_source_connector_response_dict = update_source_connector_response_instance.to_dict() +# create an instance of UpdateSourceConnectorResponse from a dict +update_source_connector_response_from_dict = UpdateSourceConnectorResponse.from_dict(update_source_connector_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/UpdateSourceConnectorResponseData.md b/docs/UpdateSourceConnectorResponseData.md new file mode 100644 index 0000000..3dfc9c4 --- /dev/null +++ b/docs/UpdateSourceConnectorResponseData.md @@ -0,0 +1,30 @@ +# UpdateSourceConnectorResponseData + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**updated_connector** | [**SourceConnector**](SourceConnector.md) | | +**pipeline_ids** | **List[str]** | | [optional] + +## Example + +```python +from vectorize_client.models.update_source_connector_response_data import UpdateSourceConnectorResponseData + +# TODO update the JSON string below +json = "{}" +# create an instance of UpdateSourceConnectorResponseData from a JSON string +update_source_connector_response_data_instance = UpdateSourceConnectorResponseData.from_json(json) +# print the JSON string representation of the object +print(UpdateSourceConnectorResponseData.to_json()) + +# convert the object into a dict +update_source_connector_response_data_dict = update_source_connector_response_data_instance.to_dict() +# create an instance of UpdateSourceConnectorResponseData from a dict +update_source_connector_response_data_from_dict = UpdateSourceConnectorResponseData.from_dict(update_source_connector_response_data_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/UpdateUserInSourceConnectorRequest.md b/docs/UpdateUserInSourceConnectorRequest.md new file mode 100644 index 0000000..e8adbea --- /dev/null +++ b/docs/UpdateUserInSourceConnectorRequest.md @@ -0,0 +1,31 @@ +# UpdateUserInSourceConnectorRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**user_id** | **str** | | +**selected_files** | [**Dict[str, AddUserToSourceConnectorRequestSelectedFilesValue]**](AddUserToSourceConnectorRequestSelectedFilesValue.md) | | [optional] +**refresh_token** | **str** | | [optional] + +## Example + +```python +from vectorize_client.models.update_user_in_source_connector_request import UpdateUserInSourceConnectorRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of UpdateUserInSourceConnectorRequest from a JSON string +update_user_in_source_connector_request_instance = UpdateUserInSourceConnectorRequest.from_json(json) +# print the JSON string representation of the object +print(UpdateUserInSourceConnectorRequest.to_json()) + +# convert the object into a dict +update_user_in_source_connector_request_dict = update_user_in_source_connector_request_instance.to_dict() +# create an instance of UpdateUserInSourceConnectorRequest from a dict +update_user_in_source_connector_request_from_dict = UpdateUserInSourceConnectorRequest.from_dict(update_user_in_source_connector_request_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/UpdateUserInSourceConnectorResponse.md b/docs/UpdateUserInSourceConnectorResponse.md new file mode 100644 index 0000000..642f1d9 --- /dev/null +++ b/docs/UpdateUserInSourceConnectorResponse.md @@ -0,0 +1,29 @@ +# UpdateUserInSourceConnectorResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **str** | | + +## Example + +```python +from vectorize_client.models.update_user_in_source_connector_response import UpdateUserInSourceConnectorResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of UpdateUserInSourceConnectorResponse from a JSON string +update_user_in_source_connector_response_instance = UpdateUserInSourceConnectorResponse.from_json(json) +# print the JSON string representation of the object +print(UpdateUserInSourceConnectorResponse.to_json()) + +# convert the object into a dict +update_user_in_source_connector_response_dict = update_user_in_source_connector_response_instance.to_dict() +# create an instance of UpdateUserInSourceConnectorResponse from a dict +update_user_in_source_connector_response_from_dict = UpdateUserInSourceConnectorResponse.from_dict(update_user_in_source_connector_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/UpdatedAIPlatformConnectorData.md b/docs/UpdatedAIPlatformConnectorData.md new file mode 100644 index 0000000..ea27d35 --- /dev/null +++ b/docs/UpdatedAIPlatformConnectorData.md @@ -0,0 +1,30 @@ +# UpdatedAIPlatformConnectorData + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**updated_connector** | [**AIPlatform**](AIPlatform.md) | | +**pipeline_ids** | **List[str]** | | [optional] + +## Example + +```python +from vectorize_client.models.updated_ai_platform_connector_data import UpdatedAIPlatformConnectorData + +# TODO update the JSON string below +json = "{}" +# create an instance of UpdatedAIPlatformConnectorData from a JSON string +updated_ai_platform_connector_data_instance = UpdatedAIPlatformConnectorData.from_json(json) +# print the JSON string representation of the object +print(UpdatedAIPlatformConnectorData.to_json()) + +# convert the object into a dict +updated_ai_platform_connector_data_dict = updated_ai_platform_connector_data_instance.to_dict() +# create an instance of UpdatedAIPlatformConnectorData from a dict +updated_ai_platform_connector_data_from_dict = UpdatedAIPlatformConnectorData.from_dict(updated_ai_platform_connector_data_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/UpdatedDestinationConnectorData.md b/docs/UpdatedDestinationConnectorData.md new file mode 100644 index 0000000..ce8ccd8 --- /dev/null +++ b/docs/UpdatedDestinationConnectorData.md @@ -0,0 +1,30 @@ +# UpdatedDestinationConnectorData + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**updated_connector** | [**DestinationConnector**](DestinationConnector.md) | | +**pipeline_ids** | **List[str]** | | [optional] + +## Example + +```python +from vectorize_client.models.updated_destination_connector_data import UpdatedDestinationConnectorData + +# TODO update the JSON string below +json = "{}" +# create an instance of UpdatedDestinationConnectorData from a JSON string +updated_destination_connector_data_instance = UpdatedDestinationConnectorData.from_json(json) +# print the JSON string representation of the object +print(UpdatedDestinationConnectorData.to_json()) + +# convert the object into a dict +updated_destination_connector_data_dict = updated_destination_connector_data_instance.to_dict() +# create an instance of UpdatedDestinationConnectorData from a dict +updated_destination_connector_data_from_dict = UpdatedDestinationConnectorData.from_dict(updated_destination_connector_data_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/UploadFile.md b/docs/UploadFile.md new file mode 100644 index 0000000..cbd0bc5 --- /dev/null +++ b/docs/UploadFile.md @@ -0,0 +1,34 @@ +# UploadFile + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **str** | | +**name** | **str** | | +**size** | **float** | | +**extension** | **str** | | [optional] +**last_modified** | **str** | | +**metadata** | **Dict[str, str]** | | + +## Example + +```python +from vectorize_client.models.upload_file import UploadFile + +# TODO update the JSON string below +json = "{}" +# create an instance of UploadFile from a JSON string +upload_file_instance = UploadFile.from_json(json) +# print the JSON string representation of the object +print(UploadFile.to_json()) + +# convert the object into a dict +upload_file_dict = upload_file_instance.to_dict() +# create an instance of UploadFile from a dict +upload_file_from_dict = UploadFile.from_dict(upload_file_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/git_push.sh b/git_push.sh new file mode 100644 index 0000000..f53a75d --- /dev/null +++ b/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/openapi.json b/openapi.json new file mode 100644 index 0000000..03bb8f0 --- /dev/null +++ b/openapi.json @@ -0,0 +1,2197 @@ +{ + "openapi": "3.0.0", + "info": { + "title": "Vectorize API (Beta)", + "version": "0.0.1", + "description": "API for Vectorize services", + "contact": { + "name": "Vectorize", + "url": "https://vectorize.io" + } + }, + "servers": [ + { + "url": "https://api.vectorize.io/v1", + "description": "Vectorize API" + } + ], + "components": { + "securitySchemes": { + "bearerAuth": { + "type": "http", + "scheme": "bearer", + "bearerFormat": "JWT" + } + }, + "schemas": { + "CreatePipelineResponse": { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "data": { + "type": "object", + "properties": { + "id": { + "type": "string" + } + }, + "required": [ + "id" + ] + } + }, + "required": [ + "message", + "data" + ] + }, + "AdvancedQuery": { + "type": "object", + "description": "Advanced query configuration for document retrieval", + "properties": { + "mode": { + "type": "string", + "enum": [ + "text", + "vector", + "hybrid" + ], + "default": "vector", + "description": "Query mode - text, vector, or hybrid" + }, + "text-fields": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Fields to search in text mode" + }, + "match-type": { + "type": "string", + "enum": [ + "match", + "match_phrase", + "multi_match" + ], + "description": "Text matching type" + }, + "text-boost": { + "type": "number", + "format": "float", + "default": 1.0, + "description": "Boost factor for text queries" + }, + "filters": { + "type": "object", + "additionalProperties": true, + "description": "Filters to apply to the query (Elasticsearch-style filters)" + } + }, + "additionalProperties": false + }, + "SourceConnectorType": { + "type": "string", + "enum": [ + "AWS_S3", + "AZURE_BLOB", + "CONFLUENCE", + "DISCORD", + "DROPBOX", + "GOOGLE_DRIVE_OAUTH", + "GOOGLE_DRIVE", + "GOOGLE_DRIVE_OAUTH_MULTI", + "GOOGLE_DRIVE_OAUTH_MULTI_CUSTOM", + "FIRECRAWL", + "GCS", + "INTERCOM", + "ONE_DRIVE", + "SHAREPOINT", + "WEB_CRAWLER", + "FILE_UPLOAD", + "SALESFORCE", + "ZENDESK" + ] + }, + "SourceConnectorSchema": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid" + }, + "type": { + "$ref": "#/components/schemas/SourceConnectorType" + }, + "config": { + "type": "object", + "additionalProperties": { + "nullable": true + } + } + }, + "required": [ + "id", + "type" + ], + "additionalProperties": false + }, + "DestinationConnectorType": { + "type": "string", + "enum": [ + "CAPELLA", + "DATASTAX", + "ELASTIC", + "PINECONE", + "SINGLESTORE", + "MILVUS", + "POSTGRESQL", + "QDRANT", + "SUPABASE", + "WEAVIATE", + "AZUREAISEARCH", + "VECTORIZE", + "CHROMA", + "MONGODB" + ] + }, + "DestinationConnectorSchema": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid" + }, + "type": { + "$ref": "#/components/schemas/DestinationConnectorType" + }, + "config": { + "type": "object", + "additionalProperties": { + "nullable": true + } + } + }, + "required": [ + "id", + "type" + ], + "additionalProperties": false + }, + "AIPlatformType": { + "type": "string", + "enum": [ + "BEDROCK", + "VERTEX", + "OPENAI", + "VOYAGE", + "VECTORIZE" + ] + }, + "AIPlatformConfigSchema": { + "type": "object", + "properties": { + "embeddingModel": { + "type": "string", + "enum": [ + "VECTORIZE_OPEN_AI_TEXT_EMBEDDING_2", + "VECTORIZE_OPEN_AI_TEXT_EMBEDDING_3_LARGE", + "VECTORIZE_OPEN_AI_TEXT_EMBEDDING_3_SMALL", + "VECTORIZE_VOYAGE_AI_2", + "VECTORIZE_VOYAGE_AI_3", + "VECTORIZE_VOYAGE_AI_3_LITE", + "VECTORIZE_VOYAGE_AI_3_LARGE", + "VECTORIZE_VOYAGE_AI_FINANCE_2", + "VECTORIZE_VOYAGE_AI_MULTILINGUAL_2", + "VECTORIZE_VOYAGE_AI_LAW_2", + "VECTORIZE_VOYAGE_AI_CODE_2", + "VECTORIZE_TITAN_TEXT_EMBEDDING_2", + "VECTORIZE_TITAN_TEXT_EMBEDDING_1", + "OPEN_AI_TEXT_EMBEDDING_2", + "OPEN_AI_TEXT_EMBEDDING_3_SMALL", + "OPEN_AI_TEXT_EMBEDDING_3_LARGE", + "VOYAGE_AI_2", + "VOYAGE_AI_3", + "VOYAGE_AI_3_LITE", + "VOYAGE_AI_3_LARGE", + "VOYAGE_AI_FINANCE_2", + "VOYAGE_AI_MULTILINGUAL_2", + "VOYAGE_AI_LAW_2", + "VOYAGE_AI_CODE_2", + "TITAN_TEXT_EMBEDDING_1", + "TITAN_TEXT_EMBEDDING_2", + "VERTEX_TEXT_EMBEDDING_4", + "VERTEX_TEXT_EMBEDDING_GECKO_3", + "VERTEX_GECKO_MULTILINGUAL_1", + "VERTEX_MULTILINGUAL_EMBEDDING_2" + ] + }, + "chunkingStrategy": { + "type": "string", + "enum": [ + "FIXED", + "SENTENCE", + "PARAGRAPH", + "MARKDOWN" + ] + }, + "chunkSize": { + "type": "integer", + "minimum": 1 + }, + "chunkOverlap": { + "type": "integer", + "minimum": 0 + }, + "dimensions": { + "type": "integer", + "minimum": 1 + }, + "extractionStrategy": { + "type": "string", + "enum": [ + "FAST", + "IRIS", + "MIXED" + ] + } + }, + "additionalProperties": false + }, + "AIPlatformSchema": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid" + }, + "type": { + "$ref": "#/components/schemas/AIPlatformType" + }, + "config": { + "$ref": "#/components/schemas/AIPlatformConfigSchema" + } + }, + "required": [ + "id", + "type", + "config" + ], + "additionalProperties": false + }, + "ScheduleSchemaType": { + "type": "string", + "enum": [ + "manual", + "realtime", + "custom" + ] + }, + "ScheduleSchema": { + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/ScheduleSchemaType" + } + }, + "required": [ + "type" + ] + }, + "PipelineConfigurationSchema": { + "type": "object", + "properties": { + "sourceConnectors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SourceConnectorSchema" + }, + "minItems": 1 + }, + "destinationConnector": { + "$ref": "#/components/schemas/DestinationConnectorSchema" + }, + "aiPlatform": { + "$ref": "#/components/schemas/AIPlatformSchema" + }, + "pipelineName": { + "type": "string", + "minLength": 1 + }, + "schedule": { + "$ref": "#/components/schemas/ScheduleSchema" + } + }, + "required": [ + "sourceConnectors", + "destinationConnector", + "aiPlatform", + "pipelineName", + "schedule" + ], + "additionalProperties": false + }, + "PipelineListSummary": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "documentCount": { + "type": "number" + }, + "sourceConnectorAuthIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "destinationConnectorAuthIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "aiPlatformAuthIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "sourceConnectorTypes": { + "type": "array", + "items": { + "type": "string" + } + }, + "destinationConnectorTypes": { + "type": "array", + "items": { + "type": "string" + } + }, + "aiPlatformTypes": { + "type": "array", + "items": { + "type": "string" + } + }, + "createdAt": { + "type": "string", + "nullable": true + }, + "createdBy": { + "type": "string" + }, + "status": { + "type": "string" + }, + "configDoc": { + "type": "object", + "additionalProperties": { + "nullable": true + } + } + }, + "required": [ + "id", + "name", + "documentCount", + "sourceConnectorAuthIds", + "destinationConnectorAuthIds", + "aiPlatformAuthIds", + "sourceConnectorTypes", + "destinationConnectorTypes", + "aiPlatformTypes", + "createdAt", + "createdBy" + ] + }, + "GetPipelinesResponse": { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PipelineListSummary" + } + } + }, + "required": [ + "message", + "data" + ] + }, + "SourceConnector": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "name": { + "type": "string" + }, + "configDoc": { + "type": "object", + "additionalProperties": { + "nullable": true + } + }, + "createdAt": { + "type": "string", + "nullable": true + }, + "createdById": { + "type": "string" + }, + "lastUpdatedById": { + "type": "string" + }, + "createdByEmail": { + "type": "string" + }, + "lastUpdatedByEmail": { + "type": "string" + }, + "errorMessage": { + "type": "string" + }, + "verificationStatus": { + "type": "string" + } + }, + "required": [ + "id", + "type", + "name" + ] + }, + "DestinationConnector": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "name": { + "type": "string" + }, + "configDoc": { + "type": "object", + "additionalProperties": { + "nullable": true + } + }, + "createdAt": { + "type": "string", + "nullable": true + }, + "createdById": { + "type": "string" + }, + "lastUpdatedById": { + "type": "string" + }, + "createdByEmail": { + "type": "string" + }, + "lastUpdatedByEmail": { + "type": "string" + }, + "errorMessage": { + "type": "string" + }, + "verificationStatus": { + "type": "string" + } + }, + "required": [ + "id", + "type", + "name" + ] + }, + "AIPlatform": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "name": { + "type": "string" + }, + "configDoc": { + "type": "object", + "additionalProperties": { + "nullable": true + } + }, + "createdAt": { + "type": "string", + "nullable": true + }, + "createdById": { + "type": "string" + }, + "lastUpdatedById": { + "type": "string" + }, + "createdByEmail": { + "type": "string" + }, + "lastUpdatedByEmail": { + "type": "string" + }, + "errorMessage": { + "type": "string" + }, + "verificationStatus": { + "type": "string" + } + }, + "required": [ + "id", + "type", + "name" + ] + }, + "PipelineSummary": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "documentCount": { + "type": "number" + }, + "sourceConnectorAuthIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "destinationConnectorAuthIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "aiPlatformAuthIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "sourceConnectorTypes": { + "type": "array", + "items": { + "type": "string" + } + }, + "destinationConnectorTypes": { + "type": "array", + "items": { + "type": "string" + } + }, + "aiPlatformTypes": { + "type": "array", + "items": { + "type": "string" + } + }, + "createdAt": { + "type": "string", + "nullable": true + }, + "createdBy": { + "type": "string" + }, + "status": { + "type": "string" + }, + "configDoc": { + "type": "object", + "additionalProperties": { + "nullable": true + } + }, + "sourceConnectors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SourceConnector" + } + }, + "destinationConnectors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DestinationConnector" + } + }, + "aiPlatforms": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AIPlatform" + } + } + }, + "required": [ + "id", + "name", + "documentCount", + "sourceConnectorAuthIds", + "destinationConnectorAuthIds", + "aiPlatformAuthIds", + "sourceConnectorTypes", + "destinationConnectorTypes", + "aiPlatformTypes", + "createdAt", + "createdBy", + "sourceConnectors", + "destinationConnectors", + "aiPlatforms" + ] + }, + "GetPipelineResponse": { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "data": { + "$ref": "#/components/schemas/PipelineSummary" + } + }, + "required": [ + "message", + "data" + ] + }, + "DeletePipelineResponse": { + "type": "object", + "properties": { + "message": { + "type": "string" + } + }, + "required": [ + "message" + ] + }, + "PipelineEvents": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "timestamp": { + "type": "string", + "nullable": true + }, + "details": { + "type": "object", + "additionalProperties": { + "nullable": true + } + }, + "summary": { + "type": "object", + "additionalProperties": { + "nullable": true + } + } + }, + "required": [ + "id", + "type", + "timestamp" + ] + }, + "GetPipelineEventsResponse": { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "nextToken": { + "type": "string" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PipelineEvents" + } + } + }, + "required": [ + "message", + "data" + ] + }, + "PipelineMetrics": { + "type": "object", + "properties": { + "timestamp": { + "type": "string", + "nullable": true + }, + "newObjects": { + "type": "number" + }, + "changedObjects": { + "type": "number" + }, + "deletedObjects": { + "type": "number" + } + }, + "required": [ + "timestamp", + "newObjects", + "changedObjects", + "deletedObjects" + ] + }, + "GetPipelineMetricsResponse": { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PipelineMetrics" + } + } + }, + "required": [ + "message", + "data" + ] + }, + "Document": { + "type": "object", + "properties": { + "relevancy": { + "type": "number" + }, + "id": { + "type": "string" + }, + "text": { + "type": "string" + }, + "chunk_id": { + "type": "string" + }, + "total_chunks": { + "type": "string" + }, + "origin": { + "type": "string" + }, + "origin_id": { + "type": "string" + }, + "similarity": { + "type": "number" + }, + "source": { + "type": "string" + }, + "unique_source": { + "type": "string" + }, + "source_display_name": { + "type": "string" + }, + "pipeline_id": { + "type": "string" + }, + "org_id": { + "type": "string" + } + }, + "required": [ + "relevancy", + "id", + "text", + "chunk_id", + "total_chunks", + "origin", + "origin_id", + "similarity", + "source", + "unique_source", + "source_display_name" + ], + "additionalProperties": true + }, + "RetrieveDocumentsResponse": { + "type": "object", + "properties": { + "question": { + "type": "string" + }, + "documents": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Document" + } + }, + "average_relevancy": { + "type": "number" + }, + "ndcg": { + "type": "number" + } + }, + "required": [ + "question", + "documents", + "average_relevancy", + "ndcg" + ] + }, + "RetrieveContextMessage": { + "type": "object", + "properties": { + "role": { + "type": "string" + }, + "content": { + "type": "string" + } + }, + "required": [ + "role", + "content" + ] + }, + "RetrieveContext": { + "type": "object", + "properties": { + "messages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RetrieveContextMessage" + } + } + }, + "required": [ + "messages" + ] + }, + "RetrieveDocumentsRequest": { + "type": "object", + "properties": { + "question": { + "type": "string" + }, + "numResults": { + "type": "number", + "minimum": 1 + }, + "rerank": { + "type": "boolean", + "default": true + }, + "metadata-filters": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": { + "nullable": true + } + } + }, + "context": { + "$ref": "#/components/schemas/RetrieveContext" + }, + "advanced-query": { + "$ref": "#/components/schemas/AdvancedQuery", + "description": "Advanced query configuration for enhanced document retrieval" + } + }, + "required": [ + "question", + "numResults" + ] + }, + "StartPipelineResponse": { + "type": "object", + "properties": { + "message": { + "type": "string" + } + }, + "required": [ + "message" + ] + }, + "StopPipelineResponse": { + "type": "object", + "properties": { + "message": { + "type": "string" + } + }, + "required": [ + "message" + ] + }, + "StartDeepResearchResponse": { + "type": "object", + "properties": { + "researchId": { + "type": "string" + } + }, + "required": [ + "researchId" + ] + }, + "N8NConfig": { + "type": "object", + "properties": { + "account": { + "type": "string" + }, + "webhookPath": { + "type": "string" + }, + "headers": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "account", + "webhookPath" + ] + }, + "StartDeepResearchRequest": { + "type": "object", + "properties": { + "query": { + "type": "string" + }, + "webSearch": { + "type": "boolean", + "default": false + }, + "schema": { + "type": "string" + }, + "n8n": { + "$ref": "#/components/schemas/N8NConfig" + } + }, + "required": [ + "query" + ] + }, + "DeepResearchResult": { + "type": "object", + "properties": { + "success": { + "type": "boolean" + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + }, + "markdown": { + "type": "string" + }, + "error": { + "type": "string" + } + }, + "required": [ + "success" + ] + }, + "GetDeepResearchResponse": { + "type": "object", + "properties": { + "ready": { + "type": "boolean" + }, + "data": { + "$ref": "#/components/schemas/DeepResearchResult" + } + }, + "required": [ + "ready" + ] + }, + "CreatedSourceConnector": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "id": { + "type": "string" + } + }, + "required": [ + "name", + "id" + ] + }, + "CreateSourceConnectorResponse": { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "connectors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CreatedSourceConnector" + } + } + }, + "required": [ + "message", + "connectors" + ] + }, + "CreateSourceConnector": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/SourceConnectorType" + }, + "config": { + "type": "object", + "additionalProperties": { + "nullable": true + } + } + }, + "required": [ + "name", + "type" + ] + }, + "CreateSourceConnectorRequest": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CreateSourceConnector" + }, + "minItems": 1 + }, + "UpdateSourceConnectorResponseData": { + "type": "object", + "properties": { + "updatedConnector": { + "$ref": "#/components/schemas/SourceConnector" + }, + "pipelineIds": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "updatedConnector" + ] + }, + "UpdateSourceConnectorResponse": { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "data": { + "$ref": "#/components/schemas/UpdateSourceConnectorResponseData" + } + }, + "required": [ + "message", + "data" + ] + }, + "UpdateSourceConnectorRequest": { + "type": "object", + "properties": { + "config": { + "type": "object", + "additionalProperties": { + "nullable": true + } + } + }, + "required": [ + "config" + ] + }, + "DeleteSourceConnectorResponse": { + "type": "object", + "properties": { + "message": { + "type": "string" + } + }, + "required": [ + "message" + ] + }, + "CreatedDestinationConnector": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "id": { + "type": "string" + } + }, + "required": [ + "name", + "id" + ] + }, + "CreateDestinationConnectorResponse": { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "connectors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CreatedDestinationConnector" + } + } + }, + "required": [ + "message", + "connectors" + ] + }, + "CreateDestinationConnector": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/DestinationConnectorType" + }, + "config": { + "type": "object", + "additionalProperties": { + "nullable": true + } + } + }, + "required": [ + "name", + "type" + ] + }, + "CreateDestinationConnectorRequest": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CreateDestinationConnector" + }, + "minItems": 1 + }, + "UpdatedDestinationConnectorData": { + "type": "object", + "properties": { + "updatedConnector": { + "$ref": "#/components/schemas/DestinationConnector" + }, + "pipelineIds": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "updatedConnector" + ] + }, + "UpdateDestinationConnectorResponse": { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "data": { + "$ref": "#/components/schemas/UpdatedDestinationConnectorData" + } + }, + "required": [ + "message", + "data" + ] + }, + "UpdateDestinationConnectorRequest": { + "type": "object", + "properties": { + "config": { + "type": "object", + "additionalProperties": { + "nullable": true + } + } + }, + "required": [ + "config" + ] + }, + "DeleteDestinationConnectorResponse": { + "type": "object", + "properties": { + "message": { + "type": "string" + } + }, + "required": [ + "message" + ] + }, + "CreatedAIPlatformConnector": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "id": { + "type": "string" + } + }, + "required": [ + "name", + "id" + ] + }, + "CreateAIPlatformConnectorResponse": { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "connectors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CreatedAIPlatformConnector" + } + } + }, + "required": [ + "message", + "connectors" + ] + }, + "CreateAIPlatformConnector": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/AIPlatformType" + }, + "config": { + "type": "object", + "additionalProperties": { + "nullable": true + } + } + }, + "required": [ + "name", + "type" + ] + }, + "CreateAIPlatformConnectorRequest": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CreateAIPlatformConnector" + }, + "minItems": 1 + }, + "UpdatedAIPlatformConnectorData": { + "type": "object", + "properties": { + "updatedConnector": { + "$ref": "#/components/schemas/AIPlatform" + }, + "pipelineIds": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "updatedConnector" + ] + }, + "UpdateAIPlatformConnectorResponse": { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "data": { + "$ref": "#/components/schemas/UpdatedAIPlatformConnectorData" + } + }, + "required": [ + "message", + "data" + ] + }, + "UpdateAIPlatformConnectorRequest": { + "type": "object", + "properties": { + "config": { + "type": "object", + "additionalProperties": { + "nullable": true + } + } + }, + "required": [ + "config" + ] + }, + "DeleteAIPlatformConnectorResponse": { + "type": "object", + "properties": { + "message": { + "type": "string" + } + }, + "required": [ + "message" + ] + }, + "UploadFile": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "size": { + "type": "number" + }, + "extension": { + "type": "string" + }, + "lastModified": { + "type": "string", + "nullable": true + }, + "metadata": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "key", + "name", + "size", + "lastModified", + "metadata" + ] + }, + "GetUploadFilesResponse": { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "files": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UploadFile" + } + } + }, + "required": [ + "message", + "files" + ] + }, + "StartFileUploadToConnectorResponse": { + "type": "object", + "properties": { + "uploadUrl": { + "type": "string" + } + }, + "required": [ + "uploadUrl" + ] + }, + "StartFileUploadToConnectorRequest": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "contentType": { + "type": "string" + }, + "metadata": { + "type": "string" + } + }, + "required": [ + "name", + "contentType" + ] + }, + "DeleteFileResponse": { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "fileName": { + "type": "string" + } + }, + "required": [ + "message", + "fileName" + ] + }, + "StartExtractionResponse": { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "extractionId": { + "type": "string" + } + }, + "required": [ + "message", + "extractionId" + ] + }, + "ExtractionType": { + "type": "string", + "enum": [ + "iris" + ], + "default": "iris" + }, + "ExtractionChunkingStrategy": { + "type": "string", + "enum": [ + "markdown" + ], + "default": "markdown" + }, + "MetadataExtractionStrategySchema": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "schema": { + "type": "string" + } + }, + "required": [ + "id", + "schema" + ] + }, + "MetadataExtractionStrategy": { + "type": "object", + "properties": { + "schemas": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MetadataExtractionStrategySchema" + } + }, + "inferSchema": { + "type": "boolean" + } + } + }, + "StartExtractionRequest": { + "type": "object", + "properties": { + "fileId": { + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/ExtractionType" + }, + "chunkingStrategy": { + "$ref": "#/components/schemas/ExtractionChunkingStrategy" + }, + "chunkSize": { + "type": "number", + "default": 256 + }, + "metadata": { + "$ref": "#/components/schemas/MetadataExtractionStrategy" + } + }, + "required": [ + "fileId" + ] + }, + "ExtractionResult": { + "type": "object", + "properties": { + "success": { + "type": "boolean" + }, + "chunks": { + "type": "array", + "items": { + "type": "string" + } + }, + "text": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "metadataSchema": { + "type": "string" + }, + "chunksMetadata": { + "type": "array", + "items": { + "type": "string" + } + }, + "chunksSchema": { + "type": "array", + "items": { + "type": "string" + } + }, + "error": { + "type": "string" + } + }, + "required": [ + "success" + ] + }, + "ExtractionResultResponse": { + "type": "object", + "properties": { + "ready": { + "type": "boolean" + }, + "data": { + "$ref": "#/components/schemas/ExtractionResult" + } + }, + "required": [ + "ready" + ] + }, + "StartFileUploadResponse": { + "type": "object", + "properties": { + "fileId": { + "type": "string" + }, + "uploadUrl": { + "type": "string" + } + }, + "required": [ + "fileId", + "uploadUrl" + ] + }, + "StartFileUploadRequest": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "contentType": { + "type": "string" + } + }, + "required": [ + "name", + "contentType" + ] + }, + "AddUserFromSourceConnectorResponse": { + "type": "object", + "properties": { + "message": { + "type": "string" + } + }, + "required": [ + "message" + ] + }, + "AddUserToSourceConnectorRequest": { + "type": "object", + "properties": { + "userId": { + "type": "string" + }, + "selectedFiles": { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "mimeType": { + "type": "string" + } + }, + "required": [ + "name", + "mimeType" + ] + } + }, + "refreshToken": { + "type": "string" + } + }, + "required": [ + "userId", + "selectedFiles", + "refreshToken" + ] + }, + "UpdateUserInSourceConnectorResponse": { + "type": "object", + "properties": { + "message": { + "type": "string" + } + }, + "required": [ + "message" + ] + }, + "UpdateUserInSourceConnectorRequest": { + "type": "object", + "properties": { + "userId": { + "type": "string" + }, + "selectedFiles": { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "mimeType": { + "type": "string" + } + }, + "required": [ + "name", + "mimeType" + ] + } + }, + "refreshToken": { + "type": "string" + } + }, + "required": [ + "userId" + ] + }, + "RemoveUserFromSourceConnectorResponse": { + "type": "object", + "properties": { + "message": { + "type": "string" + } + }, + "required": [ + "message" + ] + }, + "RemoveUserFromSourceConnectorRequest": { + "type": "object", + "properties": { + "userId": { + "type": "string" + } + }, + "required": [ + "userId" + ] + } + }, + "parameters": {} + }, + "paths": { + "/org/{organization}/pipelines": { + "post": { + "operationId": "createPipeline", + "summary": "Create a new source pipeline. Config fields for sources: Amazon S3 (AWS_S3): \nCheck for updates every (seconds) (idle-time): number, Path Prefix (path-prefix): text, Path Metadata Regex (path-metadata-regex): text, Path Regex Group Names (path-regex-group-names): array oftext) | Azure Blob Storage (AZURE_BLOB): \nPolling Interval (seconds) (idle-time): number, Path Prefix (path-prefix): text, Path Metadata Regex (path-metadata-regex): text, Path Regex Group Names (path-regex-group-names): array oftext) | Confluence (CONFLUENCE): \nSpaces (spaces): array oftext, Root Parents (root-parents): array oftext) | Discord (DISCORD): \nEmoji Filter (emoji): array oftext, Author Filter (author): array oftext, Ignore Author Filter (ignore-author): array oftext, Limit (limit): number) | Dropbox (DROPBOX): \nRead from these folders (optional) (path-prefix): array oftext) | Google Drive OAuth (GOOGLE_DRIVE_OAUTH): \nPolling Interval (seconds) (idle-time): number) | Google Drive (Service Account) (GOOGLE_DRIVE): \nRestrict ingest to these folder URLs (optional) (root-parents): array oftext, Polling Interval (seconds) (idle-time): number) | Google Drive Multi-User (Vectorize) (GOOGLE_DRIVE_OAUTH_MULTI): \nPolling Interval (seconds) (idle-time): number) | Google Drive Multi-User (White Label) (GOOGLE_DRIVE_OAUTH_MULTI_CUSTOM): \nPolling Interval (seconds) (idle-time): number) | Firecrawl (FIRECRAWL): \n) | GCP Cloud Storage (GCS): \nCheck for updates every (seconds) (idle-time): number, Path Prefix (path-prefix): text, Path Metadata Regex (path-metadata-regex): text, Path Regex Group Names (path-regex-group-names): array oftext) | Intercom (INTERCOM): \nReindex Interval (seconds) (reindexIntervalSeconds): number, Limit (limit): number, Tags (tags): array oftext) | OneDrive (ONE_DRIVE): \nRead starting from this folder (optional) (path-prefix): text) | SharePoint (SHAREPOINT): \nSite Name(s) (sites): array oftext) | Web Crawler (WEB_CRAWLER): \nAdditional Allowed URLs or prefix(es) (allowed-domains-opt): array ofurl, Forbidden Paths (forbidden-paths): array oftext, Throttle (ms) (min-time-between-requests): number, Max Error Count (max-error-count): number, Max URLs (max-urls): number, Max Depth (max-depth): number, Reindex Interval (seconds) (reindex-interval-seconds): number) | File Upload (FILE_UPLOAD): \n). Config fields for destinations: Couchbase Capella (CAPELLA): \nBucket Name (bucket): text, Scope Name (scope): text, Collection Name (collection): text, Search Index Name (index): text) | DataStax Astra (DATASTAX): \nCollection Name (collection): text) | Elasticsearch (ELASTIC): \nIndex Name (index): text) | Pinecone (PINECONE): \nIndex Name (index): text, Namespace (namespace): text) | SingleStore (SINGLESTORE): \nTable Name (table): text) | Milvus (MILVUS): \nCollection Name (collection): text) | PostgreSQL (POSTGRESQL): \nTable Name (table): text) | Qdrant (QDRANT): \nCollection Name (collection): text) | Supabase (SUPABASE): \nTable Name (table): text) | Weaviate (WEAVIATE): \nCollection Name (collection): text) | Azure AI Search (AZUREAISEARCH): \nIndex Name (index): text) | Built-in (VECTORIZE): \n) | Chroma (CHROMA): \nIndex Name (index): text) | MongoDB (MONGODB): \nIndex Name (index): text). Config fields for AI platforms: ", + "tags": [ + "Pipelines" + ], + "security": [ + { + "bearerAuth": [] + } + ], + "parameters": [ + { + "schema": { + "type": "string" + }, + "required": true, + "name": "organization", + "in": "path" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PipelineConfigurationSchema" + } + } + } + }, + "responses": { + "200": { + "description": "Pipeline created successfully", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreatePipelineResponse" + } + } + } + }, + "400": { + "description": "Invalid request", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "error": { + "type": "string" + }, + "details": { + "type": "string" + }, + "failedUpdates": { + "type": "array", + "items": { + "type": "string" + } + }, + "successfulUpdates": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "error" + ] + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "error": { + "type": "string" + }, + "details": { + "type": "string" + }, + "failedUpdates": { + "type": "array", + "items": { + "type": "string" + } + }, + "successfulUpdates": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "error" + ] + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "error": { + "type": "string" + }, + "details": { + "type": "string" + }, + "failedUpdates": { + "type": "array", + "items": { + "type": "string" + } + }, + "successfulUpdates": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "error" + ] + } + } + } + }, + "404": { + "description": "Not found", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "error": { + "type": "string" + }, + "details": { + "type": "string" + }, + "failedUpdates": { + "type": "array", + "items": { + "type": "string" + } + }, + "successfulUpdates": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "error" + ] + } + } + } + }, + "500": { + "description": "Internal server error", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "error": { + "type": "string" + }, + "details": { + "type": "string" + }, + "failedUpdates": { + "type": "array", + "items": { + "type": "string" + } + }, + "successfulUpdates": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "error" + ] + } + } + } + } + } + }, + "get": { + "operationId": "getPipelines", + "summary": "Get all existing pipelines", + "tags": [ + "Pipelines" + ], + "security": [ + { + "bearerAuth": [] + } + ], + "parameters": [ + { + "schema": { + "type": "string" + }, + "required": true, + "name": "organization", + "in": "path" + } + ], + "responses": { + "200": { + "description": "Get all pipelines", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetPipelinesResponse" + } + } + } + }, + "400": { + "description": "Invalid request", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "error": { + "type": "string" + }, + "details": { + "type": "string" + }, + "failedUpdates": { + "type": "array", + "items": { + "type": "string" + } + }, + "successfulUpdates": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "error" + ] + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "error": { + "type": "string" + }, + "details": { + "type": "string" + }, + "failedUpdates": { + "type": "array", + "items": { + "type": "string" + } + }, + "successfulUpdates": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "error" + ] + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "error": { + "type": "string" + }, + "details": { + "type": "string" + }, + "failedUpdates": { + "type": "array", + "items": { + "type": "string" + } + }, + "successfulUpdates": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "error" + ] + } + } + } + }, + "404": { + "description": "Not found", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "error": { + "type": "string" + }, + "details": { + "type": "string" + }, + "failedUpdates": { + "type": "array", + "items": { + "type": "string" + } + }, + "successfulUpdates": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "error" + ] + } + } + } + }, + "500": { + "description": "Internal server error", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "error": { + "type": "string" + }, + "details": { + "type": "string" + }, + "failedUpdates": { + "type": "array", + "items": { + "type": "string" + } + }, + "successfulUpdates": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "error" + ] + } + } + } + } + } + } + } + } +} \ No newline at end of file diff --git a/openapitools.json b/openapitools.json new file mode 100644 index 0000000..a82623d --- /dev/null +++ b/openapitools.json @@ -0,0 +1,7 @@ +{ + "$schema": "./node_modules/@openapitools/openapi-generator-cli/config.schema.json", + "spaces": 2, + "generator-cli": { + "version": "7.14.0" + } +} diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..88a9093 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,95 @@ +[project] +name = "vectorize_client" +version = "1.0.0" +description = "Vectorize API (Beta)" +authors = [ + {name = "Vectorize",email = "team@openapitools.org"}, +] +license = "NoLicense" +readme = "README.md" +keywords = ["OpenAPI", "OpenAPI-Generator", "Vectorize API (Beta)"] +requires-python = ">=3.9" + +dependencies = [ + "urllib3 (>=2.1.0,<3.0.0)", + "python-dateutil (>=2.8.2)", + "pydantic (>=2)", + "typing-extensions (>=4.7.1)" +] + +[project.urls] +Repository = "https://github.com/GIT_USER_ID/GIT_REPO_ID" + +[tool.poetry] +requires-poetry = ">=2.0" + +[tool.poetry.group.dev.dependencies] +pytest = ">= 7.2.1" +pytest-cov = ">= 2.8.1" +tox = ">= 3.9.0" +flake8 = ">= 4.0.0" +types-python-dateutil = ">= 2.8.19.14" +mypy = ">= 1.5" + + +[build-system] +requires = ["setuptools"] +build-backend = "setuptools.build_meta" + +[tool.pylint.'MESSAGES CONTROL'] +extension-pkg-whitelist = "pydantic" + +[tool.mypy] +files = [ + "vectorize_client", + #"test", # auto-generated tests + "tests", # hand-written tests +] +# TODO: enable "strict" once all these individual checks are passing +# strict = true + +# List from: https://mypy.readthedocs.io/en/stable/existing_code.html#introduce-stricter-options +warn_unused_configs = true +warn_redundant_casts = true +warn_unused_ignores = true + +## Getting these passing should be easy +strict_equality = true +extra_checks = true + +## Strongly recommend enabling this one as soon as you can +check_untyped_defs = true + +## These shouldn't be too much additional work, but may be tricky to +## get passing if you use a lot of untyped libraries +disallow_subclassing_any = true +disallow_untyped_decorators = true +disallow_any_generics = true + +### These next few are various gradations of forcing use of type annotations +#disallow_untyped_calls = true +#disallow_incomplete_defs = true +#disallow_untyped_defs = true +# +### This one isn't too hard to get passing, but return on investment is lower +#no_implicit_reexport = true +# +### This one can be tricky to get passing if you use a lot of untyped libraries +#warn_return_any = true + +[[tool.mypy.overrides]] +module = [ + "vectorize_client.configuration", +] +warn_unused_ignores = true +strict_equality = true +extra_checks = true +check_untyped_defs = true +disallow_subclassing_any = true +disallow_untyped_decorators = true +disallow_any_generics = true +disallow_untyped_calls = true +disallow_incomplete_defs = true +disallow_untyped_defs = true +no_implicit_reexport = true +warn_return_any = true diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..6cbb2b9 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,4 @@ +urllib3 >= 2.1.0, < 3.0.0 +python_dateutil >= 2.8.2 +pydantic >= 2 +typing-extensions >= 4.7.1 diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..11433ee --- /dev/null +++ b/setup.cfg @@ -0,0 +1,2 @@ +[flake8] +max-line-length=99 diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..dfe074f --- /dev/null +++ b/setup.py @@ -0,0 +1,49 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from setuptools import setup, find_packages # noqa: H301 + +# To install the library, run the following +# +# python setup.py install +# +# prerequisite: setuptools +# http://pypi.python.org/pypi/setuptools +NAME = "vectorize-client" +VERSION = "1.0.0" +PYTHON_REQUIRES = ">= 3.9" +REQUIRES = [ + "urllib3 >= 2.1.0, < 3.0.0", + "python-dateutil >= 2.8.2", + "pydantic >= 2", + "typing-extensions >= 4.7.1", +] + +setup( + name=NAME, + version=VERSION, + description="Vectorize API (Beta)", + author="Vectorize", + author_email="team@openapitools.org", + url="", + keywords=["OpenAPI", "OpenAPI-Generator", "Vectorize API (Beta)"], + install_requires=REQUIRES, + packages=find_packages(exclude=["test", "tests"]), + include_package_data=True, + long_description_content_type='text/markdown', + long_description="""\ + API for Vectorize services + """, # noqa: E501 + package_data={"vectorize_client": ["py.typed"]}, +) \ No newline at end of file diff --git a/test-requirements.txt b/test-requirements.txt new file mode 100644 index 0000000..e98555c --- /dev/null +++ b/test-requirements.txt @@ -0,0 +1,6 @@ +pytest >= 7.2.1 +pytest-cov >= 2.8.1 +tox >= 3.9.0 +flake8 >= 4.0.0 +types-python-dateutil >= 2.8.19.14 +mypy >= 1.5 diff --git a/test/__init__.py b/test/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/test/test_add_user_from_source_connector_response.py b/test/test_add_user_from_source_connector_response.py new file mode 100644 index 0000000..5b860a0 --- /dev/null +++ b/test/test_add_user_from_source_connector_response.py @@ -0,0 +1,52 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.add_user_from_source_connector_response import AddUserFromSourceConnectorResponse + +class TestAddUserFromSourceConnectorResponse(unittest.TestCase): + """AddUserFromSourceConnectorResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AddUserFromSourceConnectorResponse: + """Test AddUserFromSourceConnectorResponse + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AddUserFromSourceConnectorResponse` + """ + model = AddUserFromSourceConnectorResponse() + if include_optional: + return AddUserFromSourceConnectorResponse( + message = '' + ) + else: + return AddUserFromSourceConnectorResponse( + message = '', + ) + """ + + def testAddUserFromSourceConnectorResponse(self): + """Test AddUserFromSourceConnectorResponse""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_add_user_to_source_connector_request.py b/test/test_add_user_to_source_connector_request.py new file mode 100644 index 0000000..e2f314a --- /dev/null +++ b/test/test_add_user_to_source_connector_request.py @@ -0,0 +1,64 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.add_user_to_source_connector_request import AddUserToSourceConnectorRequest + +class TestAddUserToSourceConnectorRequest(unittest.TestCase): + """AddUserToSourceConnectorRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AddUserToSourceConnectorRequest: + """Test AddUserToSourceConnectorRequest + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AddUserToSourceConnectorRequest` + """ + model = AddUserToSourceConnectorRequest() + if include_optional: + return AddUserToSourceConnectorRequest( + user_id = '', + selected_files = { + 'key' : vectorize_client.models.add_user_to_source_connector_request_selected_files_value.AddUserToSourceConnectorRequest_selectedFiles_value( + name = '', + mime_type = '', ) + }, + refresh_token = '' + ) + else: + return AddUserToSourceConnectorRequest( + user_id = '', + selected_files = { + 'key' : vectorize_client.models.add_user_to_source_connector_request_selected_files_value.AddUserToSourceConnectorRequest_selectedFiles_value( + name = '', + mime_type = '', ) + }, + refresh_token = '', + ) + """ + + def testAddUserToSourceConnectorRequest(self): + """Test AddUserToSourceConnectorRequest""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_add_user_to_source_connector_request_selected_files_value.py b/test/test_add_user_to_source_connector_request_selected_files_value.py new file mode 100644 index 0000000..386f127 --- /dev/null +++ b/test/test_add_user_to_source_connector_request_selected_files_value.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.add_user_to_source_connector_request_selected_files_value import AddUserToSourceConnectorRequestSelectedFilesValue + +class TestAddUserToSourceConnectorRequestSelectedFilesValue(unittest.TestCase): + """AddUserToSourceConnectorRequestSelectedFilesValue unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AddUserToSourceConnectorRequestSelectedFilesValue: + """Test AddUserToSourceConnectorRequestSelectedFilesValue + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AddUserToSourceConnectorRequestSelectedFilesValue` + """ + model = AddUserToSourceConnectorRequestSelectedFilesValue() + if include_optional: + return AddUserToSourceConnectorRequestSelectedFilesValue( + name = '', + mime_type = '' + ) + else: + return AddUserToSourceConnectorRequestSelectedFilesValue( + name = '', + mime_type = '', + ) + """ + + def testAddUserToSourceConnectorRequestSelectedFilesValue(self): + """Test AddUserToSourceConnectorRequestSelectedFilesValue""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_advanced_query.py b/test/test_advanced_query.py new file mode 100644 index 0000000..4d3e398 --- /dev/null +++ b/test/test_advanced_query.py @@ -0,0 +1,57 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.advanced_query import AdvancedQuery + +class TestAdvancedQuery(unittest.TestCase): + """AdvancedQuery unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdvancedQuery: + """Test AdvancedQuery + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdvancedQuery` + """ + model = AdvancedQuery() + if include_optional: + return AdvancedQuery( + mode = 'vector', + text_fields = [ + '' + ], + match_type = 'match', + text_boost = 1.337, + filters = { } + ) + else: + return AdvancedQuery( + ) + """ + + def testAdvancedQuery(self): + """Test AdvancedQuery""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_ai_platform.py b/test/test_ai_platform.py new file mode 100644 index 0000000..0a722c4 --- /dev/null +++ b/test/test_ai_platform.py @@ -0,0 +1,66 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.ai_platform import AIPlatform + +class TestAIPlatform(unittest.TestCase): + """AIPlatform unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AIPlatform: + """Test AIPlatform + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AIPlatform` + """ + model = AIPlatform() + if include_optional: + return AIPlatform( + id = '', + type = '', + name = '', + config_doc = { + 'key' : null + }, + created_at = '', + created_by_id = '', + last_updated_by_id = '', + created_by_email = '', + last_updated_by_email = '', + error_message = '', + verification_status = '' + ) + else: + return AIPlatform( + id = '', + type = '', + name = '', + ) + """ + + def testAIPlatform(self): + """Test AIPlatform""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_ai_platform_config_schema.py b/test/test_ai_platform_config_schema.py new file mode 100644 index 0000000..21bd295 --- /dev/null +++ b/test/test_ai_platform_config_schema.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.ai_platform_config_schema import AIPlatformConfigSchema + +class TestAIPlatformConfigSchema(unittest.TestCase): + """AIPlatformConfigSchema unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AIPlatformConfigSchema: + """Test AIPlatformConfigSchema + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AIPlatformConfigSchema` + """ + model = AIPlatformConfigSchema() + if include_optional: + return AIPlatformConfigSchema( + embedding_model = 'VECTORIZE_OPEN_AI_TEXT_EMBEDDING_2', + chunking_strategy = 'FIXED', + chunk_size = 1, + chunk_overlap = 0, + dimensions = 1, + extraction_strategy = 'FAST' + ) + else: + return AIPlatformConfigSchema( + ) + """ + + def testAIPlatformConfigSchema(self): + """Test AIPlatformConfigSchema""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_ai_platform_schema.py b/test/test_ai_platform_schema.py new file mode 100644 index 0000000..fc981f2 --- /dev/null +++ b/test/test_ai_platform_schema.py @@ -0,0 +1,68 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.ai_platform_schema import AIPlatformSchema + +class TestAIPlatformSchema(unittest.TestCase): + """AIPlatformSchema unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AIPlatformSchema: + """Test AIPlatformSchema + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AIPlatformSchema` + """ + model = AIPlatformSchema() + if include_optional: + return AIPlatformSchema( + id = '', + type = 'BEDROCK', + config = vectorize_client.models.ai_platform_config_schema.AIPlatformConfigSchema( + embedding_model = 'VECTORIZE_OPEN_AI_TEXT_EMBEDDING_2', + chunking_strategy = 'FIXED', + chunk_size = 1, + chunk_overlap = 0, + dimensions = 1, + extraction_strategy = 'FAST', ) + ) + else: + return AIPlatformSchema( + id = '', + type = 'BEDROCK', + config = vectorize_client.models.ai_platform_config_schema.AIPlatformConfigSchema( + embedding_model = 'VECTORIZE_OPEN_AI_TEXT_EMBEDDING_2', + chunking_strategy = 'FIXED', + chunk_size = 1, + chunk_overlap = 0, + dimensions = 1, + extraction_strategy = 'FAST', ), + ) + """ + + def testAIPlatformSchema(self): + """Test AIPlatformSchema""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_ai_platform_type.py b/test/test_ai_platform_type.py new file mode 100644 index 0000000..3b60676 --- /dev/null +++ b/test/test_ai_platform_type.py @@ -0,0 +1,33 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.ai_platform_type import AIPlatformType + +class TestAIPlatformType(unittest.TestCase): + """AIPlatformType unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testAIPlatformType(self): + """Test AIPlatformType""" + # inst = AIPlatformType() + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_create_ai_platform_connector.py b/test/test_create_ai_platform_connector.py new file mode 100644 index 0000000..9360251 --- /dev/null +++ b/test/test_create_ai_platform_connector.py @@ -0,0 +1,57 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.create_ai_platform_connector import CreateAIPlatformConnector + +class TestCreateAIPlatformConnector(unittest.TestCase): + """CreateAIPlatformConnector unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> CreateAIPlatformConnector: + """Test CreateAIPlatformConnector + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `CreateAIPlatformConnector` + """ + model = CreateAIPlatformConnector() + if include_optional: + return CreateAIPlatformConnector( + name = '', + type = 'BEDROCK', + config = { + 'key' : null + } + ) + else: + return CreateAIPlatformConnector( + name = '', + type = 'BEDROCK', + ) + """ + + def testCreateAIPlatformConnector(self): + """Test CreateAIPlatformConnector""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_create_ai_platform_connector_response.py b/test/test_create_ai_platform_connector_response.py new file mode 100644 index 0000000..180c965 --- /dev/null +++ b/test/test_create_ai_platform_connector_response.py @@ -0,0 +1,62 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.create_ai_platform_connector_response import CreateAIPlatformConnectorResponse + +class TestCreateAIPlatformConnectorResponse(unittest.TestCase): + """CreateAIPlatformConnectorResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> CreateAIPlatformConnectorResponse: + """Test CreateAIPlatformConnectorResponse + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `CreateAIPlatformConnectorResponse` + """ + model = CreateAIPlatformConnectorResponse() + if include_optional: + return CreateAIPlatformConnectorResponse( + message = '', + connectors = [ + vectorize_client.models.created_ai_platform_connector.CreatedAIPlatformConnector( + name = '', + id = '', ) + ] + ) + else: + return CreateAIPlatformConnectorResponse( + message = '', + connectors = [ + vectorize_client.models.created_ai_platform_connector.CreatedAIPlatformConnector( + name = '', + id = '', ) + ], + ) + """ + + def testCreateAIPlatformConnectorResponse(self): + """Test CreateAIPlatformConnectorResponse""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_create_destination_connector.py b/test/test_create_destination_connector.py new file mode 100644 index 0000000..2964feb --- /dev/null +++ b/test/test_create_destination_connector.py @@ -0,0 +1,57 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.create_destination_connector import CreateDestinationConnector + +class TestCreateDestinationConnector(unittest.TestCase): + """CreateDestinationConnector unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> CreateDestinationConnector: + """Test CreateDestinationConnector + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `CreateDestinationConnector` + """ + model = CreateDestinationConnector() + if include_optional: + return CreateDestinationConnector( + name = '', + type = 'CAPELLA', + config = { + 'key' : null + } + ) + else: + return CreateDestinationConnector( + name = '', + type = 'CAPELLA', + ) + """ + + def testCreateDestinationConnector(self): + """Test CreateDestinationConnector""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_create_destination_connector_response.py b/test/test_create_destination_connector_response.py new file mode 100644 index 0000000..6930994 --- /dev/null +++ b/test/test_create_destination_connector_response.py @@ -0,0 +1,62 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.create_destination_connector_response import CreateDestinationConnectorResponse + +class TestCreateDestinationConnectorResponse(unittest.TestCase): + """CreateDestinationConnectorResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> CreateDestinationConnectorResponse: + """Test CreateDestinationConnectorResponse + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `CreateDestinationConnectorResponse` + """ + model = CreateDestinationConnectorResponse() + if include_optional: + return CreateDestinationConnectorResponse( + message = '', + connectors = [ + vectorize_client.models.created_destination_connector.CreatedDestinationConnector( + name = '', + id = '', ) + ] + ) + else: + return CreateDestinationConnectorResponse( + message = '', + connectors = [ + vectorize_client.models.created_destination_connector.CreatedDestinationConnector( + name = '', + id = '', ) + ], + ) + """ + + def testCreateDestinationConnectorResponse(self): + """Test CreateDestinationConnectorResponse""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_create_pipeline_response.py b/test/test_create_pipeline_response.py new file mode 100644 index 0000000..83bce6c --- /dev/null +++ b/test/test_create_pipeline_response.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.create_pipeline_response import CreatePipelineResponse + +class TestCreatePipelineResponse(unittest.TestCase): + """CreatePipelineResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> CreatePipelineResponse: + """Test CreatePipelineResponse + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `CreatePipelineResponse` + """ + model = CreatePipelineResponse() + if include_optional: + return CreatePipelineResponse( + message = '', + data = vectorize_client.models.create_pipeline_response_data.CreatePipelineResponse_data( + id = '', ) + ) + else: + return CreatePipelineResponse( + message = '', + data = vectorize_client.models.create_pipeline_response_data.CreatePipelineResponse_data( + id = '', ), + ) + """ + + def testCreatePipelineResponse(self): + """Test CreatePipelineResponse""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_create_pipeline_response_data.py b/test/test_create_pipeline_response_data.py new file mode 100644 index 0000000..02c392d --- /dev/null +++ b/test/test_create_pipeline_response_data.py @@ -0,0 +1,52 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.create_pipeline_response_data import CreatePipelineResponseData + +class TestCreatePipelineResponseData(unittest.TestCase): + """CreatePipelineResponseData unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> CreatePipelineResponseData: + """Test CreatePipelineResponseData + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `CreatePipelineResponseData` + """ + model = CreatePipelineResponseData() + if include_optional: + return CreatePipelineResponseData( + id = '' + ) + else: + return CreatePipelineResponseData( + id = '', + ) + """ + + def testCreatePipelineResponseData(self): + """Test CreatePipelineResponseData""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_create_source_connector.py b/test/test_create_source_connector.py new file mode 100644 index 0000000..b0d691f --- /dev/null +++ b/test/test_create_source_connector.py @@ -0,0 +1,57 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.create_source_connector import CreateSourceConnector + +class TestCreateSourceConnector(unittest.TestCase): + """CreateSourceConnector unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> CreateSourceConnector: + """Test CreateSourceConnector + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `CreateSourceConnector` + """ + model = CreateSourceConnector() + if include_optional: + return CreateSourceConnector( + name = '', + type = 'AWS_S3', + config = { + 'key' : null + } + ) + else: + return CreateSourceConnector( + name = '', + type = 'AWS_S3', + ) + """ + + def testCreateSourceConnector(self): + """Test CreateSourceConnector""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_create_source_connector_response.py b/test/test_create_source_connector_response.py new file mode 100644 index 0000000..ea4c592 --- /dev/null +++ b/test/test_create_source_connector_response.py @@ -0,0 +1,62 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.create_source_connector_response import CreateSourceConnectorResponse + +class TestCreateSourceConnectorResponse(unittest.TestCase): + """CreateSourceConnectorResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> CreateSourceConnectorResponse: + """Test CreateSourceConnectorResponse + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `CreateSourceConnectorResponse` + """ + model = CreateSourceConnectorResponse() + if include_optional: + return CreateSourceConnectorResponse( + message = '', + connectors = [ + vectorize_client.models.created_source_connector.CreatedSourceConnector( + name = '', + id = '', ) + ] + ) + else: + return CreateSourceConnectorResponse( + message = '', + connectors = [ + vectorize_client.models.created_source_connector.CreatedSourceConnector( + name = '', + id = '', ) + ], + ) + """ + + def testCreateSourceConnectorResponse(self): + """Test CreateSourceConnectorResponse""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_created_ai_platform_connector.py b/test/test_created_ai_platform_connector.py new file mode 100644 index 0000000..07318e4 --- /dev/null +++ b/test/test_created_ai_platform_connector.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.created_ai_platform_connector import CreatedAIPlatformConnector + +class TestCreatedAIPlatformConnector(unittest.TestCase): + """CreatedAIPlatformConnector unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> CreatedAIPlatformConnector: + """Test CreatedAIPlatformConnector + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `CreatedAIPlatformConnector` + """ + model = CreatedAIPlatformConnector() + if include_optional: + return CreatedAIPlatformConnector( + name = '', + id = '' + ) + else: + return CreatedAIPlatformConnector( + name = '', + id = '', + ) + """ + + def testCreatedAIPlatformConnector(self): + """Test CreatedAIPlatformConnector""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_created_destination_connector.py b/test/test_created_destination_connector.py new file mode 100644 index 0000000..c8c3d2e --- /dev/null +++ b/test/test_created_destination_connector.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.created_destination_connector import CreatedDestinationConnector + +class TestCreatedDestinationConnector(unittest.TestCase): + """CreatedDestinationConnector unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> CreatedDestinationConnector: + """Test CreatedDestinationConnector + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `CreatedDestinationConnector` + """ + model = CreatedDestinationConnector() + if include_optional: + return CreatedDestinationConnector( + name = '', + id = '' + ) + else: + return CreatedDestinationConnector( + name = '', + id = '', + ) + """ + + def testCreatedDestinationConnector(self): + """Test CreatedDestinationConnector""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_created_source_connector.py b/test/test_created_source_connector.py new file mode 100644 index 0000000..9ee69a5 --- /dev/null +++ b/test/test_created_source_connector.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.created_source_connector import CreatedSourceConnector + +class TestCreatedSourceConnector(unittest.TestCase): + """CreatedSourceConnector unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> CreatedSourceConnector: + """Test CreatedSourceConnector + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `CreatedSourceConnector` + """ + model = CreatedSourceConnector() + if include_optional: + return CreatedSourceConnector( + name = '', + id = '' + ) + else: + return CreatedSourceConnector( + name = '', + id = '', + ) + """ + + def testCreatedSourceConnector(self): + """Test CreatedSourceConnector""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_deep_research_result.py b/test/test_deep_research_result.py new file mode 100644 index 0000000..3ae3128 --- /dev/null +++ b/test/test_deep_research_result.py @@ -0,0 +1,57 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.deep_research_result import DeepResearchResult + +class TestDeepResearchResult(unittest.TestCase): + """DeepResearchResult unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DeepResearchResult: + """Test DeepResearchResult + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DeepResearchResult` + """ + model = DeepResearchResult() + if include_optional: + return DeepResearchResult( + success = True, + events = [ + '' + ], + markdown = '', + error = '' + ) + else: + return DeepResearchResult( + success = True, + ) + """ + + def testDeepResearchResult(self): + """Test DeepResearchResult""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_delete_ai_platform_connector_response.py b/test/test_delete_ai_platform_connector_response.py new file mode 100644 index 0000000..04ce996 --- /dev/null +++ b/test/test_delete_ai_platform_connector_response.py @@ -0,0 +1,52 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.delete_ai_platform_connector_response import DeleteAIPlatformConnectorResponse + +class TestDeleteAIPlatformConnectorResponse(unittest.TestCase): + """DeleteAIPlatformConnectorResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DeleteAIPlatformConnectorResponse: + """Test DeleteAIPlatformConnectorResponse + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DeleteAIPlatformConnectorResponse` + """ + model = DeleteAIPlatformConnectorResponse() + if include_optional: + return DeleteAIPlatformConnectorResponse( + message = '' + ) + else: + return DeleteAIPlatformConnectorResponse( + message = '', + ) + """ + + def testDeleteAIPlatformConnectorResponse(self): + """Test DeleteAIPlatformConnectorResponse""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_delete_destination_connector_response.py b/test/test_delete_destination_connector_response.py new file mode 100644 index 0000000..5186c27 --- /dev/null +++ b/test/test_delete_destination_connector_response.py @@ -0,0 +1,52 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.delete_destination_connector_response import DeleteDestinationConnectorResponse + +class TestDeleteDestinationConnectorResponse(unittest.TestCase): + """DeleteDestinationConnectorResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DeleteDestinationConnectorResponse: + """Test DeleteDestinationConnectorResponse + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DeleteDestinationConnectorResponse` + """ + model = DeleteDestinationConnectorResponse() + if include_optional: + return DeleteDestinationConnectorResponse( + message = '' + ) + else: + return DeleteDestinationConnectorResponse( + message = '', + ) + """ + + def testDeleteDestinationConnectorResponse(self): + """Test DeleteDestinationConnectorResponse""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_delete_file_response.py b/test/test_delete_file_response.py new file mode 100644 index 0000000..d37fbbd --- /dev/null +++ b/test/test_delete_file_response.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.delete_file_response import DeleteFileResponse + +class TestDeleteFileResponse(unittest.TestCase): + """DeleteFileResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DeleteFileResponse: + """Test DeleteFileResponse + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DeleteFileResponse` + """ + model = DeleteFileResponse() + if include_optional: + return DeleteFileResponse( + message = '', + file_name = '' + ) + else: + return DeleteFileResponse( + message = '', + file_name = '', + ) + """ + + def testDeleteFileResponse(self): + """Test DeleteFileResponse""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_delete_pipeline_response.py b/test/test_delete_pipeline_response.py new file mode 100644 index 0000000..4f2afc6 --- /dev/null +++ b/test/test_delete_pipeline_response.py @@ -0,0 +1,52 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.delete_pipeline_response import DeletePipelineResponse + +class TestDeletePipelineResponse(unittest.TestCase): + """DeletePipelineResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DeletePipelineResponse: + """Test DeletePipelineResponse + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DeletePipelineResponse` + """ + model = DeletePipelineResponse() + if include_optional: + return DeletePipelineResponse( + message = '' + ) + else: + return DeletePipelineResponse( + message = '', + ) + """ + + def testDeletePipelineResponse(self): + """Test DeletePipelineResponse""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_delete_source_connector_response.py b/test/test_delete_source_connector_response.py new file mode 100644 index 0000000..238230e --- /dev/null +++ b/test/test_delete_source_connector_response.py @@ -0,0 +1,52 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.delete_source_connector_response import DeleteSourceConnectorResponse + +class TestDeleteSourceConnectorResponse(unittest.TestCase): + """DeleteSourceConnectorResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DeleteSourceConnectorResponse: + """Test DeleteSourceConnectorResponse + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DeleteSourceConnectorResponse` + """ + model = DeleteSourceConnectorResponse() + if include_optional: + return DeleteSourceConnectorResponse( + message = '' + ) + else: + return DeleteSourceConnectorResponse( + message = '', + ) + """ + + def testDeleteSourceConnectorResponse(self): + """Test DeleteSourceConnectorResponse""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_destination_connector.py b/test/test_destination_connector.py new file mode 100644 index 0000000..c84b147 --- /dev/null +++ b/test/test_destination_connector.py @@ -0,0 +1,66 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.destination_connector import DestinationConnector + +class TestDestinationConnector(unittest.TestCase): + """DestinationConnector unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DestinationConnector: + """Test DestinationConnector + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DestinationConnector` + """ + model = DestinationConnector() + if include_optional: + return DestinationConnector( + id = '', + type = '', + name = '', + config_doc = { + 'key' : null + }, + created_at = '', + created_by_id = '', + last_updated_by_id = '', + created_by_email = '', + last_updated_by_email = '', + error_message = '', + verification_status = '' + ) + else: + return DestinationConnector( + id = '', + type = '', + name = '', + ) + """ + + def testDestinationConnector(self): + """Test DestinationConnector""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_destination_connector_schema.py b/test/test_destination_connector_schema.py new file mode 100644 index 0000000..d962f82 --- /dev/null +++ b/test/test_destination_connector_schema.py @@ -0,0 +1,57 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.destination_connector_schema import DestinationConnectorSchema + +class TestDestinationConnectorSchema(unittest.TestCase): + """DestinationConnectorSchema unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DestinationConnectorSchema: + """Test DestinationConnectorSchema + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DestinationConnectorSchema` + """ + model = DestinationConnectorSchema() + if include_optional: + return DestinationConnectorSchema( + id = '', + type = 'CAPELLA', + config = { + 'key' : null + } + ) + else: + return DestinationConnectorSchema( + id = '', + type = 'CAPELLA', + ) + """ + + def testDestinationConnectorSchema(self): + """Test DestinationConnectorSchema""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_destination_connector_type.py b/test/test_destination_connector_type.py new file mode 100644 index 0000000..eff1fc8 --- /dev/null +++ b/test/test_destination_connector_type.py @@ -0,0 +1,33 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.destination_connector_type import DestinationConnectorType + +class TestDestinationConnectorType(unittest.TestCase): + """DestinationConnectorType unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testDestinationConnectorType(self): + """Test DestinationConnectorType""" + # inst = DestinationConnectorType() + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_document.py b/test/test_document.py new file mode 100644 index 0000000..cc3c36d --- /dev/null +++ b/test/test_document.py @@ -0,0 +1,74 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.document import Document + +class TestDocument(unittest.TestCase): + """Document unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> Document: + """Test Document + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `Document` + """ + model = Document() + if include_optional: + return Document( + relevancy = 1.337, + id = '', + text = '', + chunk_id = '', + total_chunks = '', + origin = '', + origin_id = '', + similarity = 1.337, + source = '', + unique_source = '', + source_display_name = '', + pipeline_id = '', + org_id = '' + ) + else: + return Document( + relevancy = 1.337, + id = '', + text = '', + chunk_id = '', + total_chunks = '', + origin = '', + origin_id = '', + similarity = 1.337, + source = '', + unique_source = '', + source_display_name = '', + ) + """ + + def testDocument(self): + """Test Document""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_extraction_chunking_strategy.py b/test/test_extraction_chunking_strategy.py new file mode 100644 index 0000000..6f5f877 --- /dev/null +++ b/test/test_extraction_chunking_strategy.py @@ -0,0 +1,33 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.extraction_chunking_strategy import ExtractionChunkingStrategy + +class TestExtractionChunkingStrategy(unittest.TestCase): + """ExtractionChunkingStrategy unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testExtractionChunkingStrategy(self): + """Test ExtractionChunkingStrategy""" + # inst = ExtractionChunkingStrategy() + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_extraction_result.py b/test/test_extraction_result.py new file mode 100644 index 0000000..e16f67c --- /dev/null +++ b/test/test_extraction_result.py @@ -0,0 +1,65 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.extraction_result import ExtractionResult + +class TestExtractionResult(unittest.TestCase): + """ExtractionResult unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ExtractionResult: + """Test ExtractionResult + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ExtractionResult` + """ + model = ExtractionResult() + if include_optional: + return ExtractionResult( + success = True, + chunks = [ + '' + ], + text = '', + metadata = '', + metadata_schema = '', + chunks_metadata = [ + '' + ], + chunks_schema = [ + '' + ], + error = '' + ) + else: + return ExtractionResult( + success = True, + ) + """ + + def testExtractionResult(self): + """Test ExtractionResult""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_extraction_result_response.py b/test/test_extraction_result_response.py new file mode 100644 index 0000000..16c230a --- /dev/null +++ b/test/test_extraction_result_response.py @@ -0,0 +1,67 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.extraction_result_response import ExtractionResultResponse + +class TestExtractionResultResponse(unittest.TestCase): + """ExtractionResultResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ExtractionResultResponse: + """Test ExtractionResultResponse + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ExtractionResultResponse` + """ + model = ExtractionResultResponse() + if include_optional: + return ExtractionResultResponse( + ready = True, + data = vectorize_client.models.extraction_result.ExtractionResult( + success = True, + chunks = [ + '' + ], + text = '', + metadata = '', + metadata_schema = '', + chunks_metadata = [ + '' + ], + chunks_schema = [ + '' + ], + error = '', ) + ) + else: + return ExtractionResultResponse( + ready = True, + ) + """ + + def testExtractionResultResponse(self): + """Test ExtractionResultResponse""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_extraction_type.py b/test/test_extraction_type.py new file mode 100644 index 0000000..58d7197 --- /dev/null +++ b/test/test_extraction_type.py @@ -0,0 +1,33 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.extraction_type import ExtractionType + +class TestExtractionType(unittest.TestCase): + """ExtractionType unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testExtractionType(self): + """Test ExtractionType""" + # inst = ExtractionType() + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_get_deep_research_response.py b/test/test_get_deep_research_response.py new file mode 100644 index 0000000..83c813c --- /dev/null +++ b/test/test_get_deep_research_response.py @@ -0,0 +1,59 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.get_deep_research_response import GetDeepResearchResponse + +class TestGetDeepResearchResponse(unittest.TestCase): + """GetDeepResearchResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> GetDeepResearchResponse: + """Test GetDeepResearchResponse + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `GetDeepResearchResponse` + """ + model = GetDeepResearchResponse() + if include_optional: + return GetDeepResearchResponse( + ready = True, + data = vectorize_client.models.deep_research_result.DeepResearchResult( + success = True, + events = [ + '' + ], + markdown = '', + error = '', ) + ) + else: + return GetDeepResearchResponse( + ready = True, + ) + """ + + def testGetDeepResearchResponse(self): + """Test GetDeepResearchResponse""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_get_pipeline_events_response.py b/test/test_get_pipeline_events_response.py new file mode 100644 index 0000000..dcb6975 --- /dev/null +++ b/test/test_get_pipeline_events_response.py @@ -0,0 +1,77 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.get_pipeline_events_response import GetPipelineEventsResponse + +class TestGetPipelineEventsResponse(unittest.TestCase): + """GetPipelineEventsResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> GetPipelineEventsResponse: + """Test GetPipelineEventsResponse + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `GetPipelineEventsResponse` + """ + model = GetPipelineEventsResponse() + if include_optional: + return GetPipelineEventsResponse( + message = '', + next_token = '', + data = [ + vectorize_client.models.pipeline_events.PipelineEvents( + id = '', + type = '', + timestamp = '', + details = { + 'key' : null + }, + summary = { + 'key' : null + }, ) + ] + ) + else: + return GetPipelineEventsResponse( + message = '', + data = [ + vectorize_client.models.pipeline_events.PipelineEvents( + id = '', + type = '', + timestamp = '', + details = { + 'key' : null + }, + summary = { + 'key' : null + }, ) + ], + ) + """ + + def testGetPipelineEventsResponse(self): + """Test GetPipelineEventsResponse""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_get_pipeline_metrics_response.py b/test/test_get_pipeline_metrics_response.py new file mode 100644 index 0000000..dec5311 --- /dev/null +++ b/test/test_get_pipeline_metrics_response.py @@ -0,0 +1,66 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.get_pipeline_metrics_response import GetPipelineMetricsResponse + +class TestGetPipelineMetricsResponse(unittest.TestCase): + """GetPipelineMetricsResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> GetPipelineMetricsResponse: + """Test GetPipelineMetricsResponse + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `GetPipelineMetricsResponse` + """ + model = GetPipelineMetricsResponse() + if include_optional: + return GetPipelineMetricsResponse( + message = '', + data = [ + vectorize_client.models.pipeline_metrics.PipelineMetrics( + timestamp = '', + new_objects = 1.337, + changed_objects = 1.337, + deleted_objects = 1.337, ) + ] + ) + else: + return GetPipelineMetricsResponse( + message = '', + data = [ + vectorize_client.models.pipeline_metrics.PipelineMetrics( + timestamp = '', + new_objects = 1.337, + changed_objects = 1.337, + deleted_objects = 1.337, ) + ], + ) + """ + + def testGetPipelineMetricsResponse(self): + """Test GetPipelineMetricsResponse""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_get_pipeline_response.py b/test/test_get_pipeline_response.py new file mode 100644 index 0000000..c25d03c --- /dev/null +++ b/test/test_get_pipeline_response.py @@ -0,0 +1,186 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.get_pipeline_response import GetPipelineResponse + +class TestGetPipelineResponse(unittest.TestCase): + """GetPipelineResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> GetPipelineResponse: + """Test GetPipelineResponse + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `GetPipelineResponse` + """ + model = GetPipelineResponse() + if include_optional: + return GetPipelineResponse( + message = '', + data = vectorize_client.models.pipeline_summary.PipelineSummary( + id = '', + name = '', + document_count = 1.337, + source_connector_auth_ids = [ + '' + ], + destination_connector_auth_ids = [ + '' + ], + ai_platform_auth_ids = [ + '' + ], + source_connector_types = [ + '' + ], + destination_connector_types = [ + '' + ], + ai_platform_types = [ + '' + ], + created_at = '', + created_by = '', + status = '', + config_doc = { + 'key' : null + }, + source_connectors = [ + vectorize_client.models.source_connector.SourceConnector( + id = '', + type = '', + name = '', + created_at = '', + created_by_id = '', + last_updated_by_id = '', + created_by_email = '', + last_updated_by_email = '', + error_message = '', + verification_status = '', ) + ], + destination_connectors = [ + vectorize_client.models.destination_connector.DestinationConnector( + id = '', + type = '', + name = '', + created_at = '', + created_by_id = '', + last_updated_by_id = '', + created_by_email = '', + last_updated_by_email = '', + error_message = '', + verification_status = '', ) + ], + ai_platforms = [ + vectorize_client.models.ai_platform.AIPlatform( + id = '', + type = '', + name = '', + created_at = '', + created_by_id = '', + last_updated_by_id = '', + created_by_email = '', + last_updated_by_email = '', + error_message = '', + verification_status = '', ) + ], ) + ) + else: + return GetPipelineResponse( + message = '', + data = vectorize_client.models.pipeline_summary.PipelineSummary( + id = '', + name = '', + document_count = 1.337, + source_connector_auth_ids = [ + '' + ], + destination_connector_auth_ids = [ + '' + ], + ai_platform_auth_ids = [ + '' + ], + source_connector_types = [ + '' + ], + destination_connector_types = [ + '' + ], + ai_platform_types = [ + '' + ], + created_at = '', + created_by = '', + status = '', + config_doc = { + 'key' : null + }, + source_connectors = [ + vectorize_client.models.source_connector.SourceConnector( + id = '', + type = '', + name = '', + created_at = '', + created_by_id = '', + last_updated_by_id = '', + created_by_email = '', + last_updated_by_email = '', + error_message = '', + verification_status = '', ) + ], + destination_connectors = [ + vectorize_client.models.destination_connector.DestinationConnector( + id = '', + type = '', + name = '', + created_at = '', + created_by_id = '', + last_updated_by_id = '', + created_by_email = '', + last_updated_by_email = '', + error_message = '', + verification_status = '', ) + ], + ai_platforms = [ + vectorize_client.models.ai_platform.AIPlatform( + id = '', + type = '', + name = '', + created_at = '', + created_by_id = '', + last_updated_by_id = '', + created_by_email = '', + last_updated_by_email = '', + error_message = '', + verification_status = '', ) + ], ), + ) + """ + + def testGetPipelineResponse(self): + """Test GetPipelineResponse""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_get_pipelines400_response.py b/test/test_get_pipelines400_response.py new file mode 100644 index 0000000..8da3612 --- /dev/null +++ b/test/test_get_pipelines400_response.py @@ -0,0 +1,59 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.get_pipelines400_response import GetPipelines400Response + +class TestGetPipelines400Response(unittest.TestCase): + """GetPipelines400Response unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> GetPipelines400Response: + """Test GetPipelines400Response + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `GetPipelines400Response` + """ + model = GetPipelines400Response() + if include_optional: + return GetPipelines400Response( + error = '', + details = '', + failed_updates = [ + '' + ], + successful_updates = [ + '' + ] + ) + else: + return GetPipelines400Response( + error = '', + ) + """ + + def testGetPipelines400Response(self): + """Test GetPipelines400Response""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_get_pipelines_response.py b/test/test_get_pipelines_response.py new file mode 100644 index 0000000..37e25c7 --- /dev/null +++ b/test/test_get_pipelines_response.py @@ -0,0 +1,112 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.get_pipelines_response import GetPipelinesResponse + +class TestGetPipelinesResponse(unittest.TestCase): + """GetPipelinesResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> GetPipelinesResponse: + """Test GetPipelinesResponse + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `GetPipelinesResponse` + """ + model = GetPipelinesResponse() + if include_optional: + return GetPipelinesResponse( + message = '', + data = [ + vectorize_client.models.pipeline_list_summary.PipelineListSummary( + id = '', + name = '', + document_count = 1.337, + source_connector_auth_ids = [ + '' + ], + destination_connector_auth_ids = [ + '' + ], + ai_platform_auth_ids = [ + '' + ], + source_connector_types = [ + '' + ], + destination_connector_types = [ + '' + ], + ai_platform_types = [ + '' + ], + created_at = '', + created_by = '', + status = '', + config_doc = { + 'key' : null + }, ) + ] + ) + else: + return GetPipelinesResponse( + message = '', + data = [ + vectorize_client.models.pipeline_list_summary.PipelineListSummary( + id = '', + name = '', + document_count = 1.337, + source_connector_auth_ids = [ + '' + ], + destination_connector_auth_ids = [ + '' + ], + ai_platform_auth_ids = [ + '' + ], + source_connector_types = [ + '' + ], + destination_connector_types = [ + '' + ], + ai_platform_types = [ + '' + ], + created_at = '', + created_by = '', + status = '', + config_doc = { + 'key' : null + }, ) + ], + ) + """ + + def testGetPipelinesResponse(self): + """Test GetPipelinesResponse""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_get_upload_files_response.py b/test/test_get_upload_files_response.py new file mode 100644 index 0000000..8501f98 --- /dev/null +++ b/test/test_get_upload_files_response.py @@ -0,0 +1,74 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.get_upload_files_response import GetUploadFilesResponse + +class TestGetUploadFilesResponse(unittest.TestCase): + """GetUploadFilesResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> GetUploadFilesResponse: + """Test GetUploadFilesResponse + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `GetUploadFilesResponse` + """ + model = GetUploadFilesResponse() + if include_optional: + return GetUploadFilesResponse( + message = '', + files = [ + vectorize_client.models.upload_file.UploadFile( + key = '', + name = '', + size = 1.337, + extension = '', + last_modified = '', + metadata = { + 'key' : '' + }, ) + ] + ) + else: + return GetUploadFilesResponse( + message = '', + files = [ + vectorize_client.models.upload_file.UploadFile( + key = '', + name = '', + size = 1.337, + extension = '', + last_modified = '', + metadata = { + 'key' : '' + }, ) + ], + ) + """ + + def testGetUploadFilesResponse(self): + """Test GetUploadFilesResponse""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_metadata_extraction_strategy.py b/test/test_metadata_extraction_strategy.py new file mode 100644 index 0000000..41f9cff --- /dev/null +++ b/test/test_metadata_extraction_strategy.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.metadata_extraction_strategy import MetadataExtractionStrategy + +class TestMetadataExtractionStrategy(unittest.TestCase): + """MetadataExtractionStrategy unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> MetadataExtractionStrategy: + """Test MetadataExtractionStrategy + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `MetadataExtractionStrategy` + """ + model = MetadataExtractionStrategy() + if include_optional: + return MetadataExtractionStrategy( + schemas = [ + vectorize_client.models.metadata_extraction_strategy_schema.MetadataExtractionStrategySchema( + id = '', + schema = '', ) + ], + infer_schema = True + ) + else: + return MetadataExtractionStrategy( + ) + """ + + def testMetadataExtractionStrategy(self): + """Test MetadataExtractionStrategy""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_metadata_extraction_strategy_schema.py b/test/test_metadata_extraction_strategy_schema.py new file mode 100644 index 0000000..be310e1 --- /dev/null +++ b/test/test_metadata_extraction_strategy_schema.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.metadata_extraction_strategy_schema import MetadataExtractionStrategySchema + +class TestMetadataExtractionStrategySchema(unittest.TestCase): + """MetadataExtractionStrategySchema unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> MetadataExtractionStrategySchema: + """Test MetadataExtractionStrategySchema + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `MetadataExtractionStrategySchema` + """ + model = MetadataExtractionStrategySchema() + if include_optional: + return MetadataExtractionStrategySchema( + id = '', + var_schema = '' + ) + else: + return MetadataExtractionStrategySchema( + id = '', + var_schema = '', + ) + """ + + def testMetadataExtractionStrategySchema(self): + """Test MetadataExtractionStrategySchema""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_n8_n_config.py b/test/test_n8_n_config.py new file mode 100644 index 0000000..7d4f027 --- /dev/null +++ b/test/test_n8_n_config.py @@ -0,0 +1,57 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.n8_n_config import N8NConfig + +class TestN8NConfig(unittest.TestCase): + """N8NConfig unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> N8NConfig: + """Test N8NConfig + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `N8NConfig` + """ + model = N8NConfig() + if include_optional: + return N8NConfig( + account = '', + webhook_path = '', + headers = { + 'key' : '' + } + ) + else: + return N8NConfig( + account = '', + webhook_path = '', + ) + """ + + def testN8NConfig(self): + """Test N8NConfig""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_pipeline_configuration_schema.py b/test/test_pipeline_configuration_schema.py new file mode 100644 index 0000000..c2a53d0 --- /dev/null +++ b/test/test_pipeline_configuration_schema.py @@ -0,0 +1,104 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.pipeline_configuration_schema import PipelineConfigurationSchema + +class TestPipelineConfigurationSchema(unittest.TestCase): + """PipelineConfigurationSchema unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> PipelineConfigurationSchema: + """Test PipelineConfigurationSchema + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `PipelineConfigurationSchema` + """ + model = PipelineConfigurationSchema() + if include_optional: + return PipelineConfigurationSchema( + source_connectors = [ + vectorize_client.models.source_connector_schema.SourceConnectorSchema( + id = '', + type = 'AWS_S3', + config = { + 'key' : null + }, ) + ], + destination_connector = vectorize_client.models.destination_connector_schema.DestinationConnectorSchema( + id = '', + type = 'CAPELLA', + config = { + 'key' : null + }, ), + ai_platform = vectorize_client.models.ai_platform_schema.AIPlatformSchema( + id = '', + type = 'BEDROCK', + config = vectorize_client.models.ai_platform_config_schema.AIPlatformConfigSchema( + embedding_model = 'VECTORIZE_OPEN_AI_TEXT_EMBEDDING_2', + chunking_strategy = 'FIXED', + chunk_size = 1, + chunk_overlap = 0, + dimensions = 1, + extraction_strategy = 'FAST', ), ), + pipeline_name = '0', + schedule = vectorize_client.models.schedule_schema.ScheduleSchema( + type = 'manual', ) + ) + else: + return PipelineConfigurationSchema( + source_connectors = [ + vectorize_client.models.source_connector_schema.SourceConnectorSchema( + id = '', + type = 'AWS_S3', + config = { + 'key' : null + }, ) + ], + destination_connector = vectorize_client.models.destination_connector_schema.DestinationConnectorSchema( + id = '', + type = 'CAPELLA', + config = { + 'key' : null + }, ), + ai_platform = vectorize_client.models.ai_platform_schema.AIPlatformSchema( + id = '', + type = 'BEDROCK', + config = vectorize_client.models.ai_platform_config_schema.AIPlatformConfigSchema( + embedding_model = 'VECTORIZE_OPEN_AI_TEXT_EMBEDDING_2', + chunking_strategy = 'FIXED', + chunk_size = 1, + chunk_overlap = 0, + dimensions = 1, + extraction_strategy = 'FAST', ), ), + pipeline_name = '0', + schedule = vectorize_client.models.schedule_schema.ScheduleSchema( + type = 'manual', ), + ) + """ + + def testPipelineConfigurationSchema(self): + """Test PipelineConfigurationSchema""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_pipeline_events.py b/test/test_pipeline_events.py new file mode 100644 index 0000000..05e5ee9 --- /dev/null +++ b/test/test_pipeline_events.py @@ -0,0 +1,62 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.pipeline_events import PipelineEvents + +class TestPipelineEvents(unittest.TestCase): + """PipelineEvents unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> PipelineEvents: + """Test PipelineEvents + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `PipelineEvents` + """ + model = PipelineEvents() + if include_optional: + return PipelineEvents( + id = '', + type = '', + timestamp = '', + details = { + 'key' : null + }, + summary = { + 'key' : null + } + ) + else: + return PipelineEvents( + id = '', + type = '', + timestamp = '', + ) + """ + + def testPipelineEvents(self): + """Test PipelineEvents""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_pipeline_list_summary.py b/test/test_pipeline_list_summary.py new file mode 100644 index 0000000..e2b5b44 --- /dev/null +++ b/test/test_pipeline_list_summary.py @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.pipeline_list_summary import PipelineListSummary + +class TestPipelineListSummary(unittest.TestCase): + """PipelineListSummary unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> PipelineListSummary: + """Test PipelineListSummary + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `PipelineListSummary` + """ + model = PipelineListSummary() + if include_optional: + return PipelineListSummary( + id = '', + name = '', + document_count = 1.337, + source_connector_auth_ids = [ + '' + ], + destination_connector_auth_ids = [ + '' + ], + ai_platform_auth_ids = [ + '' + ], + source_connector_types = [ + '' + ], + destination_connector_types = [ + '' + ], + ai_platform_types = [ + '' + ], + created_at = '', + created_by = '', + status = '', + config_doc = { + 'key' : null + } + ) + else: + return PipelineListSummary( + id = '', + name = '', + document_count = 1.337, + source_connector_auth_ids = [ + '' + ], + destination_connector_auth_ids = [ + '' + ], + ai_platform_auth_ids = [ + '' + ], + source_connector_types = [ + '' + ], + destination_connector_types = [ + '' + ], + ai_platform_types = [ + '' + ], + created_at = '', + created_by = '', + ) + """ + + def testPipelineListSummary(self): + """Test PipelineListSummary""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_pipeline_metrics.py b/test/test_pipeline_metrics.py new file mode 100644 index 0000000..43c82d0 --- /dev/null +++ b/test/test_pipeline_metrics.py @@ -0,0 +1,58 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.pipeline_metrics import PipelineMetrics + +class TestPipelineMetrics(unittest.TestCase): + """PipelineMetrics unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> PipelineMetrics: + """Test PipelineMetrics + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `PipelineMetrics` + """ + model = PipelineMetrics() + if include_optional: + return PipelineMetrics( + timestamp = '', + new_objects = 1.337, + changed_objects = 1.337, + deleted_objects = 1.337 + ) + else: + return PipelineMetrics( + timestamp = '', + new_objects = 1.337, + changed_objects = 1.337, + deleted_objects = 1.337, + ) + """ + + def testPipelineMetrics(self): + """Test PipelineMetrics""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_pipeline_summary.py b/test/test_pipeline_summary.py new file mode 100644 index 0000000..4ffa1f8 --- /dev/null +++ b/test/test_pipeline_summary.py @@ -0,0 +1,196 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.pipeline_summary import PipelineSummary + +class TestPipelineSummary(unittest.TestCase): + """PipelineSummary unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> PipelineSummary: + """Test PipelineSummary + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `PipelineSummary` + """ + model = PipelineSummary() + if include_optional: + return PipelineSummary( + id = '', + name = '', + document_count = 1.337, + source_connector_auth_ids = [ + '' + ], + destination_connector_auth_ids = [ + '' + ], + ai_platform_auth_ids = [ + '' + ], + source_connector_types = [ + '' + ], + destination_connector_types = [ + '' + ], + ai_platform_types = [ + '' + ], + created_at = '', + created_by = '', + status = '', + config_doc = { + 'key' : null + }, + source_connectors = [ + vectorize_client.models.source_connector.SourceConnector( + id = '', + type = '', + name = '', + config_doc = { + 'key' : null + }, + created_at = '', + created_by_id = '', + last_updated_by_id = '', + created_by_email = '', + last_updated_by_email = '', + error_message = '', + verification_status = '', ) + ], + destination_connectors = [ + vectorize_client.models.destination_connector.DestinationConnector( + id = '', + type = '', + name = '', + config_doc = { + 'key' : null + }, + created_at = '', + created_by_id = '', + last_updated_by_id = '', + created_by_email = '', + last_updated_by_email = '', + error_message = '', + verification_status = '', ) + ], + ai_platforms = [ + vectorize_client.models.ai_platform.AIPlatform( + id = '', + type = '', + name = '', + config_doc = { + 'key' : null + }, + created_at = '', + created_by_id = '', + last_updated_by_id = '', + created_by_email = '', + last_updated_by_email = '', + error_message = '', + verification_status = '', ) + ] + ) + else: + return PipelineSummary( + id = '', + name = '', + document_count = 1.337, + source_connector_auth_ids = [ + '' + ], + destination_connector_auth_ids = [ + '' + ], + ai_platform_auth_ids = [ + '' + ], + source_connector_types = [ + '' + ], + destination_connector_types = [ + '' + ], + ai_platform_types = [ + '' + ], + created_at = '', + created_by = '', + source_connectors = [ + vectorize_client.models.source_connector.SourceConnector( + id = '', + type = '', + name = '', + config_doc = { + 'key' : null + }, + created_at = '', + created_by_id = '', + last_updated_by_id = '', + created_by_email = '', + last_updated_by_email = '', + error_message = '', + verification_status = '', ) + ], + destination_connectors = [ + vectorize_client.models.destination_connector.DestinationConnector( + id = '', + type = '', + name = '', + config_doc = { + 'key' : null + }, + created_at = '', + created_by_id = '', + last_updated_by_id = '', + created_by_email = '', + last_updated_by_email = '', + error_message = '', + verification_status = '', ) + ], + ai_platforms = [ + vectorize_client.models.ai_platform.AIPlatform( + id = '', + type = '', + name = '', + config_doc = { + 'key' : null + }, + created_at = '', + created_by_id = '', + last_updated_by_id = '', + created_by_email = '', + last_updated_by_email = '', + error_message = '', + verification_status = '', ) + ], + ) + """ + + def testPipelineSummary(self): + """Test PipelineSummary""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_pipelines_api.py b/test/test_pipelines_api.py new file mode 100644 index 0000000..3bf7e51 --- /dev/null +++ b/test/test_pipelines_api.py @@ -0,0 +1,45 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.api.pipelines_api import PipelinesApi + + +class TestPipelinesApi(unittest.TestCase): + """PipelinesApi unit test stubs""" + + def setUp(self) -> None: + self.api = PipelinesApi() + + def tearDown(self) -> None: + pass + + def test_create_pipeline(self) -> None: + """Test case for create_pipeline + + Create a new source pipeline. Config fields for sources: Amazon S3 (AWS_S3): Check for updates every (seconds) (idle-time): number, Path Prefix (path-prefix): text, Path Metadata Regex (path-metadata-regex): text, Path Regex Group Names (path-regex-group-names): array oftext) | Azure Blob Storage (AZURE_BLOB): Polling Interval (seconds) (idle-time): number, Path Prefix (path-prefix): text, Path Metadata Regex (path-metadata-regex): text, Path Regex Group Names (path-regex-group-names): array oftext) | Confluence (CONFLUENCE): Spaces (spaces): array oftext, Root Parents (root-parents): array oftext) | Discord (DISCORD): Emoji Filter (emoji): array oftext, Author Filter (author): array oftext, Ignore Author Filter (ignore-author): array oftext, Limit (limit): number) | Dropbox (DROPBOX): Read from these folders (optional) (path-prefix): array oftext) | Google Drive OAuth (GOOGLE_DRIVE_OAUTH): Polling Interval (seconds) (idle-time): number) | Google Drive (Service Account) (GOOGLE_DRIVE): Restrict ingest to these folder URLs (optional) (root-parents): array oftext, Polling Interval (seconds) (idle-time): number) | Google Drive Multi-User (Vectorize) (GOOGLE_DRIVE_OAUTH_MULTI): Polling Interval (seconds) (idle-time): number) | Google Drive Multi-User (White Label) (GOOGLE_DRIVE_OAUTH_MULTI_CUSTOM): Polling Interval (seconds) (idle-time): number) | Firecrawl (FIRECRAWL): ) | GCP Cloud Storage (GCS): Check for updates every (seconds) (idle-time): number, Path Prefix (path-prefix): text, Path Metadata Regex (path-metadata-regex): text, Path Regex Group Names (path-regex-group-names): array oftext) | Intercom (INTERCOM): Reindex Interval (seconds) (reindexIntervalSeconds): number, Limit (limit): number, Tags (tags): array oftext) | OneDrive (ONE_DRIVE): Read starting from this folder (optional) (path-prefix): text) | SharePoint (SHAREPOINT): Site Name(s) (sites): array oftext) | Web Crawler (WEB_CRAWLER): Additional Allowed URLs or prefix(es) (allowed-domains-opt): array ofurl, Forbidden Paths (forbidden-paths): array oftext, Throttle (ms) (min-time-between-requests): number, Max Error Count (max-error-count): number, Max URLs (max-urls): number, Max Depth (max-depth): number, Reindex Interval (seconds) (reindex-interval-seconds): number) | File Upload (FILE_UPLOAD): ). Config fields for destinations: Couchbase Capella (CAPELLA): Bucket Name (bucket): text, Scope Name (scope): text, Collection Name (collection): text, Search Index Name (index): text) | DataStax Astra (DATASTAX): Collection Name (collection): text) | Elasticsearch (ELASTIC): Index Name (index): text) | Pinecone (PINECONE): Index Name (index): text, Namespace (namespace): text) | SingleStore (SINGLESTORE): Table Name (table): text) | Milvus (MILVUS): Collection Name (collection): text) | PostgreSQL (POSTGRESQL): Table Name (table): text) | Qdrant (QDRANT): Collection Name (collection): text) | Supabase (SUPABASE): Table Name (table): text) | Weaviate (WEAVIATE): Collection Name (collection): text) | Azure AI Search (AZUREAISEARCH): Index Name (index): text) | Built-in (VECTORIZE): ) | Chroma (CHROMA): Index Name (index): text) | MongoDB (MONGODB): Index Name (index): text). Config fields for AI platforms: + """ + pass + + def test_get_pipelines(self) -> None: + """Test case for get_pipelines + + Get all existing pipelines + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_remove_user_from_source_connector_request.py b/test/test_remove_user_from_source_connector_request.py new file mode 100644 index 0000000..54d12be --- /dev/null +++ b/test/test_remove_user_from_source_connector_request.py @@ -0,0 +1,52 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.remove_user_from_source_connector_request import RemoveUserFromSourceConnectorRequest + +class TestRemoveUserFromSourceConnectorRequest(unittest.TestCase): + """RemoveUserFromSourceConnectorRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> RemoveUserFromSourceConnectorRequest: + """Test RemoveUserFromSourceConnectorRequest + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `RemoveUserFromSourceConnectorRequest` + """ + model = RemoveUserFromSourceConnectorRequest() + if include_optional: + return RemoveUserFromSourceConnectorRequest( + user_id = '' + ) + else: + return RemoveUserFromSourceConnectorRequest( + user_id = '', + ) + """ + + def testRemoveUserFromSourceConnectorRequest(self): + """Test RemoveUserFromSourceConnectorRequest""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_remove_user_from_source_connector_response.py b/test/test_remove_user_from_source_connector_response.py new file mode 100644 index 0000000..6135534 --- /dev/null +++ b/test/test_remove_user_from_source_connector_response.py @@ -0,0 +1,52 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.remove_user_from_source_connector_response import RemoveUserFromSourceConnectorResponse + +class TestRemoveUserFromSourceConnectorResponse(unittest.TestCase): + """RemoveUserFromSourceConnectorResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> RemoveUserFromSourceConnectorResponse: + """Test RemoveUserFromSourceConnectorResponse + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `RemoveUserFromSourceConnectorResponse` + """ + model = RemoveUserFromSourceConnectorResponse() + if include_optional: + return RemoveUserFromSourceConnectorResponse( + message = '' + ) + else: + return RemoveUserFromSourceConnectorResponse( + message = '', + ) + """ + + def testRemoveUserFromSourceConnectorResponse(self): + """Test RemoveUserFromSourceConnectorResponse""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_retrieve_context.py b/test/test_retrieve_context.py new file mode 100644 index 0000000..dc7aca6 --- /dev/null +++ b/test/test_retrieve_context.py @@ -0,0 +1,60 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.retrieve_context import RetrieveContext + +class TestRetrieveContext(unittest.TestCase): + """RetrieveContext unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> RetrieveContext: + """Test RetrieveContext + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `RetrieveContext` + """ + model = RetrieveContext() + if include_optional: + return RetrieveContext( + messages = [ + vectorize_client.models.retrieve_context_message.RetrieveContextMessage( + role = '', + content = '', ) + ] + ) + else: + return RetrieveContext( + messages = [ + vectorize_client.models.retrieve_context_message.RetrieveContextMessage( + role = '', + content = '', ) + ], + ) + """ + + def testRetrieveContext(self): + """Test RetrieveContext""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_retrieve_context_message.py b/test/test_retrieve_context_message.py new file mode 100644 index 0000000..65ad2d6 --- /dev/null +++ b/test/test_retrieve_context_message.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.retrieve_context_message import RetrieveContextMessage + +class TestRetrieveContextMessage(unittest.TestCase): + """RetrieveContextMessage unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> RetrieveContextMessage: + """Test RetrieveContextMessage + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `RetrieveContextMessage` + """ + model = RetrieveContextMessage() + if include_optional: + return RetrieveContextMessage( + role = '', + content = '' + ) + else: + return RetrieveContextMessage( + role = '', + content = '', + ) + """ + + def testRetrieveContextMessage(self): + """Test RetrieveContextMessage""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_retrieve_documents_request.py b/test/test_retrieve_documents_request.py new file mode 100644 index 0000000..71a11e4 --- /dev/null +++ b/test/test_retrieve_documents_request.py @@ -0,0 +1,74 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.retrieve_documents_request import RetrieveDocumentsRequest + +class TestRetrieveDocumentsRequest(unittest.TestCase): + """RetrieveDocumentsRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> RetrieveDocumentsRequest: + """Test RetrieveDocumentsRequest + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `RetrieveDocumentsRequest` + """ + model = RetrieveDocumentsRequest() + if include_optional: + return RetrieveDocumentsRequest( + question = '', + num_results = 1, + rerank = True, + metadata_filters = [ + { + 'key' : null + } + ], + context = vectorize_client.models.retrieve_context.RetrieveContext( + messages = [ + vectorize_client.models.retrieve_context_message.RetrieveContextMessage( + role = '', + content = '', ) + ], ), + advanced_query = vectorize_client.models.advanced_query.AdvancedQuery( + mode = 'vector', + text_fields = [ + '' + ], + match_type = 'match', + text_boost = 1.337, + filters = { }, ) + ) + else: + return RetrieveDocumentsRequest( + question = '', + num_results = 1, + ) + """ + + def testRetrieveDocumentsRequest(self): + """Test RetrieveDocumentsRequest""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_retrieve_documents_response.py b/test/test_retrieve_documents_response.py new file mode 100644 index 0000000..62d8f80 --- /dev/null +++ b/test/test_retrieve_documents_response.py @@ -0,0 +1,62 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.retrieve_documents_response import RetrieveDocumentsResponse + +class TestRetrieveDocumentsResponse(unittest.TestCase): + """RetrieveDocumentsResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> RetrieveDocumentsResponse: + """Test RetrieveDocumentsResponse + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `RetrieveDocumentsResponse` + """ + model = RetrieveDocumentsResponse() + if include_optional: + return RetrieveDocumentsResponse( + question = '', + documents = [ + { } + ], + average_relevancy = 1.337, + ndcg = 1.337 + ) + else: + return RetrieveDocumentsResponse( + question = '', + documents = [ + { } + ], + average_relevancy = 1.337, + ndcg = 1.337, + ) + """ + + def testRetrieveDocumentsResponse(self): + """Test RetrieveDocumentsResponse""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_schedule_schema.py b/test/test_schedule_schema.py new file mode 100644 index 0000000..f2acfd5 --- /dev/null +++ b/test/test_schedule_schema.py @@ -0,0 +1,52 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.schedule_schema import ScheduleSchema + +class TestScheduleSchema(unittest.TestCase): + """ScheduleSchema unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ScheduleSchema: + """Test ScheduleSchema + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ScheduleSchema` + """ + model = ScheduleSchema() + if include_optional: + return ScheduleSchema( + type = 'manual' + ) + else: + return ScheduleSchema( + type = 'manual', + ) + """ + + def testScheduleSchema(self): + """Test ScheduleSchema""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_schedule_schema_type.py b/test/test_schedule_schema_type.py new file mode 100644 index 0000000..4da55a4 --- /dev/null +++ b/test/test_schedule_schema_type.py @@ -0,0 +1,33 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.schedule_schema_type import ScheduleSchemaType + +class TestScheduleSchemaType(unittest.TestCase): + """ScheduleSchemaType unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testScheduleSchemaType(self): + """Test ScheduleSchemaType""" + # inst = ScheduleSchemaType() + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_source_connector.py b/test/test_source_connector.py new file mode 100644 index 0000000..b69671c --- /dev/null +++ b/test/test_source_connector.py @@ -0,0 +1,66 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.source_connector import SourceConnector + +class TestSourceConnector(unittest.TestCase): + """SourceConnector unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> SourceConnector: + """Test SourceConnector + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `SourceConnector` + """ + model = SourceConnector() + if include_optional: + return SourceConnector( + id = '', + type = '', + name = '', + config_doc = { + 'key' : null + }, + created_at = '', + created_by_id = '', + last_updated_by_id = '', + created_by_email = '', + last_updated_by_email = '', + error_message = '', + verification_status = '' + ) + else: + return SourceConnector( + id = '', + type = '', + name = '', + ) + """ + + def testSourceConnector(self): + """Test SourceConnector""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_source_connector_schema.py b/test/test_source_connector_schema.py new file mode 100644 index 0000000..fe29e7f --- /dev/null +++ b/test/test_source_connector_schema.py @@ -0,0 +1,57 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.source_connector_schema import SourceConnectorSchema + +class TestSourceConnectorSchema(unittest.TestCase): + """SourceConnectorSchema unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> SourceConnectorSchema: + """Test SourceConnectorSchema + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `SourceConnectorSchema` + """ + model = SourceConnectorSchema() + if include_optional: + return SourceConnectorSchema( + id = '', + type = 'AWS_S3', + config = { + 'key' : null + } + ) + else: + return SourceConnectorSchema( + id = '', + type = 'AWS_S3', + ) + """ + + def testSourceConnectorSchema(self): + """Test SourceConnectorSchema""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_source_connector_type.py b/test/test_source_connector_type.py new file mode 100644 index 0000000..6763ae3 --- /dev/null +++ b/test/test_source_connector_type.py @@ -0,0 +1,33 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.source_connector_type import SourceConnectorType + +class TestSourceConnectorType(unittest.TestCase): + """SourceConnectorType unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testSourceConnectorType(self): + """Test SourceConnectorType""" + # inst = SourceConnectorType() + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_start_deep_research_request.py b/test/test_start_deep_research_request.py new file mode 100644 index 0000000..ef09d32 --- /dev/null +++ b/test/test_start_deep_research_request.py @@ -0,0 +1,60 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.start_deep_research_request import StartDeepResearchRequest + +class TestStartDeepResearchRequest(unittest.TestCase): + """StartDeepResearchRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> StartDeepResearchRequest: + """Test StartDeepResearchRequest + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `StartDeepResearchRequest` + """ + model = StartDeepResearchRequest() + if include_optional: + return StartDeepResearchRequest( + query = '', + web_search = True, + var_schema = '', + n8n = vectorize_client.models.n8_n_config.N8NConfig( + account = '', + webhook_path = '', + headers = { + 'key' : '' + }, ) + ) + else: + return StartDeepResearchRequest( + query = '', + ) + """ + + def testStartDeepResearchRequest(self): + """Test StartDeepResearchRequest""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_start_deep_research_response.py b/test/test_start_deep_research_response.py new file mode 100644 index 0000000..3040805 --- /dev/null +++ b/test/test_start_deep_research_response.py @@ -0,0 +1,52 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.start_deep_research_response import StartDeepResearchResponse + +class TestStartDeepResearchResponse(unittest.TestCase): + """StartDeepResearchResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> StartDeepResearchResponse: + """Test StartDeepResearchResponse + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `StartDeepResearchResponse` + """ + model = StartDeepResearchResponse() + if include_optional: + return StartDeepResearchResponse( + research_id = '' + ) + else: + return StartDeepResearchResponse( + research_id = '', + ) + """ + + def testStartDeepResearchResponse(self): + """Test StartDeepResearchResponse""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_start_extraction_request.py b/test/test_start_extraction_request.py new file mode 100644 index 0000000..3065a94 --- /dev/null +++ b/test/test_start_extraction_request.py @@ -0,0 +1,62 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.start_extraction_request import StartExtractionRequest + +class TestStartExtractionRequest(unittest.TestCase): + """StartExtractionRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> StartExtractionRequest: + """Test StartExtractionRequest + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `StartExtractionRequest` + """ + model = StartExtractionRequest() + if include_optional: + return StartExtractionRequest( + file_id = '', + type = 'iris', + chunking_strategy = 'markdown', + chunk_size = 1.337, + metadata = vectorize_client.models.metadata_extraction_strategy.MetadataExtractionStrategy( + schemas = [ + vectorize_client.models.metadata_extraction_strategy_schema.MetadataExtractionStrategySchema( + id = '', + schema = '', ) + ], + infer_schema = True, ) + ) + else: + return StartExtractionRequest( + file_id = '', + ) + """ + + def testStartExtractionRequest(self): + """Test StartExtractionRequest""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_start_extraction_response.py b/test/test_start_extraction_response.py new file mode 100644 index 0000000..3ccde59 --- /dev/null +++ b/test/test_start_extraction_response.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.start_extraction_response import StartExtractionResponse + +class TestStartExtractionResponse(unittest.TestCase): + """StartExtractionResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> StartExtractionResponse: + """Test StartExtractionResponse + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `StartExtractionResponse` + """ + model = StartExtractionResponse() + if include_optional: + return StartExtractionResponse( + message = '', + extraction_id = '' + ) + else: + return StartExtractionResponse( + message = '', + extraction_id = '', + ) + """ + + def testStartExtractionResponse(self): + """Test StartExtractionResponse""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_start_file_upload_request.py b/test/test_start_file_upload_request.py new file mode 100644 index 0000000..8fbe096 --- /dev/null +++ b/test/test_start_file_upload_request.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.start_file_upload_request import StartFileUploadRequest + +class TestStartFileUploadRequest(unittest.TestCase): + """StartFileUploadRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> StartFileUploadRequest: + """Test StartFileUploadRequest + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `StartFileUploadRequest` + """ + model = StartFileUploadRequest() + if include_optional: + return StartFileUploadRequest( + name = '', + content_type = '' + ) + else: + return StartFileUploadRequest( + name = '', + content_type = '', + ) + """ + + def testStartFileUploadRequest(self): + """Test StartFileUploadRequest""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_start_file_upload_response.py b/test/test_start_file_upload_response.py new file mode 100644 index 0000000..f515309 --- /dev/null +++ b/test/test_start_file_upload_response.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.start_file_upload_response import StartFileUploadResponse + +class TestStartFileUploadResponse(unittest.TestCase): + """StartFileUploadResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> StartFileUploadResponse: + """Test StartFileUploadResponse + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `StartFileUploadResponse` + """ + model = StartFileUploadResponse() + if include_optional: + return StartFileUploadResponse( + file_id = '', + upload_url = '' + ) + else: + return StartFileUploadResponse( + file_id = '', + upload_url = '', + ) + """ + + def testStartFileUploadResponse(self): + """Test StartFileUploadResponse""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_start_file_upload_to_connector_request.py b/test/test_start_file_upload_to_connector_request.py new file mode 100644 index 0000000..d049fe6 --- /dev/null +++ b/test/test_start_file_upload_to_connector_request.py @@ -0,0 +1,55 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.start_file_upload_to_connector_request import StartFileUploadToConnectorRequest + +class TestStartFileUploadToConnectorRequest(unittest.TestCase): + """StartFileUploadToConnectorRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> StartFileUploadToConnectorRequest: + """Test StartFileUploadToConnectorRequest + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `StartFileUploadToConnectorRequest` + """ + model = StartFileUploadToConnectorRequest() + if include_optional: + return StartFileUploadToConnectorRequest( + name = '', + content_type = '', + metadata = '' + ) + else: + return StartFileUploadToConnectorRequest( + name = '', + content_type = '', + ) + """ + + def testStartFileUploadToConnectorRequest(self): + """Test StartFileUploadToConnectorRequest""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_start_file_upload_to_connector_response.py b/test/test_start_file_upload_to_connector_response.py new file mode 100644 index 0000000..cc24548 --- /dev/null +++ b/test/test_start_file_upload_to_connector_response.py @@ -0,0 +1,52 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.start_file_upload_to_connector_response import StartFileUploadToConnectorResponse + +class TestStartFileUploadToConnectorResponse(unittest.TestCase): + """StartFileUploadToConnectorResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> StartFileUploadToConnectorResponse: + """Test StartFileUploadToConnectorResponse + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `StartFileUploadToConnectorResponse` + """ + model = StartFileUploadToConnectorResponse() + if include_optional: + return StartFileUploadToConnectorResponse( + upload_url = '' + ) + else: + return StartFileUploadToConnectorResponse( + upload_url = '', + ) + """ + + def testStartFileUploadToConnectorResponse(self): + """Test StartFileUploadToConnectorResponse""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_start_pipeline_response.py b/test/test_start_pipeline_response.py new file mode 100644 index 0000000..6ef4675 --- /dev/null +++ b/test/test_start_pipeline_response.py @@ -0,0 +1,52 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.start_pipeline_response import StartPipelineResponse + +class TestStartPipelineResponse(unittest.TestCase): + """StartPipelineResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> StartPipelineResponse: + """Test StartPipelineResponse + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `StartPipelineResponse` + """ + model = StartPipelineResponse() + if include_optional: + return StartPipelineResponse( + message = '' + ) + else: + return StartPipelineResponse( + message = '', + ) + """ + + def testStartPipelineResponse(self): + """Test StartPipelineResponse""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_stop_pipeline_response.py b/test/test_stop_pipeline_response.py new file mode 100644 index 0000000..50afb4d --- /dev/null +++ b/test/test_stop_pipeline_response.py @@ -0,0 +1,52 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.stop_pipeline_response import StopPipelineResponse + +class TestStopPipelineResponse(unittest.TestCase): + """StopPipelineResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> StopPipelineResponse: + """Test StopPipelineResponse + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `StopPipelineResponse` + """ + model = StopPipelineResponse() + if include_optional: + return StopPipelineResponse( + message = '' + ) + else: + return StopPipelineResponse( + message = '', + ) + """ + + def testStopPipelineResponse(self): + """Test StopPipelineResponse""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_update_ai_platform_connector_request.py b/test/test_update_ai_platform_connector_request.py new file mode 100644 index 0000000..8784330 --- /dev/null +++ b/test/test_update_ai_platform_connector_request.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.update_ai_platform_connector_request import UpdateAIPlatformConnectorRequest + +class TestUpdateAIPlatformConnectorRequest(unittest.TestCase): + """UpdateAIPlatformConnectorRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> UpdateAIPlatformConnectorRequest: + """Test UpdateAIPlatformConnectorRequest + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `UpdateAIPlatformConnectorRequest` + """ + model = UpdateAIPlatformConnectorRequest() + if include_optional: + return UpdateAIPlatformConnectorRequest( + config = { + 'key' : null + } + ) + else: + return UpdateAIPlatformConnectorRequest( + config = { + 'key' : null + }, + ) + """ + + def testUpdateAIPlatformConnectorRequest(self): + """Test UpdateAIPlatformConnectorRequest""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_update_ai_platform_connector_response.py b/test/test_update_ai_platform_connector_response.py new file mode 100644 index 0000000..179c1f7 --- /dev/null +++ b/test/test_update_ai_platform_connector_response.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.update_ai_platform_connector_response import UpdateAIPlatformConnectorResponse + +class TestUpdateAIPlatformConnectorResponse(unittest.TestCase): + """UpdateAIPlatformConnectorResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> UpdateAIPlatformConnectorResponse: + """Test UpdateAIPlatformConnectorResponse + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `UpdateAIPlatformConnectorResponse` + """ + model = UpdateAIPlatformConnectorResponse() + if include_optional: + return UpdateAIPlatformConnectorResponse( + message = '', + data = vectorize_client.models.updated_ai_platform_connector_data.UpdatedAIPlatformConnectorData( + updated_connector = vectorize_client.models.ai_platform.AIPlatform( + id = '', + type = '', + name = '', + config_doc = { + 'key' : null + }, + created_at = '', + created_by_id = '', + last_updated_by_id = '', + created_by_email = '', + last_updated_by_email = '', + error_message = '', + verification_status = '', ), + pipeline_ids = [ + '' + ], ) + ) + else: + return UpdateAIPlatformConnectorResponse( + message = '', + data = vectorize_client.models.updated_ai_platform_connector_data.UpdatedAIPlatformConnectorData( + updated_connector = vectorize_client.models.ai_platform.AIPlatform( + id = '', + type = '', + name = '', + config_doc = { + 'key' : null + }, + created_at = '', + created_by_id = '', + last_updated_by_id = '', + created_by_email = '', + last_updated_by_email = '', + error_message = '', + verification_status = '', ), + pipeline_ids = [ + '' + ], ), + ) + """ + + def testUpdateAIPlatformConnectorResponse(self): + """Test UpdateAIPlatformConnectorResponse""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_update_destination_connector_request.py b/test/test_update_destination_connector_request.py new file mode 100644 index 0000000..8539637 --- /dev/null +++ b/test/test_update_destination_connector_request.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.update_destination_connector_request import UpdateDestinationConnectorRequest + +class TestUpdateDestinationConnectorRequest(unittest.TestCase): + """UpdateDestinationConnectorRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> UpdateDestinationConnectorRequest: + """Test UpdateDestinationConnectorRequest + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `UpdateDestinationConnectorRequest` + """ + model = UpdateDestinationConnectorRequest() + if include_optional: + return UpdateDestinationConnectorRequest( + config = { + 'key' : null + } + ) + else: + return UpdateDestinationConnectorRequest( + config = { + 'key' : null + }, + ) + """ + + def testUpdateDestinationConnectorRequest(self): + """Test UpdateDestinationConnectorRequest""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_update_destination_connector_response.py b/test/test_update_destination_connector_response.py new file mode 100644 index 0000000..765a722 --- /dev/null +++ b/test/test_update_destination_connector_response.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.update_destination_connector_response import UpdateDestinationConnectorResponse + +class TestUpdateDestinationConnectorResponse(unittest.TestCase): + """UpdateDestinationConnectorResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> UpdateDestinationConnectorResponse: + """Test UpdateDestinationConnectorResponse + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `UpdateDestinationConnectorResponse` + """ + model = UpdateDestinationConnectorResponse() + if include_optional: + return UpdateDestinationConnectorResponse( + message = '', + data = vectorize_client.models.updated_destination_connector_data.UpdatedDestinationConnectorData( + updated_connector = vectorize_client.models.destination_connector.DestinationConnector( + id = '', + type = '', + name = '', + config_doc = { + 'key' : null + }, + created_at = '', + created_by_id = '', + last_updated_by_id = '', + created_by_email = '', + last_updated_by_email = '', + error_message = '', + verification_status = '', ), + pipeline_ids = [ + '' + ], ) + ) + else: + return UpdateDestinationConnectorResponse( + message = '', + data = vectorize_client.models.updated_destination_connector_data.UpdatedDestinationConnectorData( + updated_connector = vectorize_client.models.destination_connector.DestinationConnector( + id = '', + type = '', + name = '', + config_doc = { + 'key' : null + }, + created_at = '', + created_by_id = '', + last_updated_by_id = '', + created_by_email = '', + last_updated_by_email = '', + error_message = '', + verification_status = '', ), + pipeline_ids = [ + '' + ], ), + ) + """ + + def testUpdateDestinationConnectorResponse(self): + """Test UpdateDestinationConnectorResponse""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_update_source_connector_request.py b/test/test_update_source_connector_request.py new file mode 100644 index 0000000..d8878fe --- /dev/null +++ b/test/test_update_source_connector_request.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.update_source_connector_request import UpdateSourceConnectorRequest + +class TestUpdateSourceConnectorRequest(unittest.TestCase): + """UpdateSourceConnectorRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> UpdateSourceConnectorRequest: + """Test UpdateSourceConnectorRequest + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `UpdateSourceConnectorRequest` + """ + model = UpdateSourceConnectorRequest() + if include_optional: + return UpdateSourceConnectorRequest( + config = { + 'key' : null + } + ) + else: + return UpdateSourceConnectorRequest( + config = { + 'key' : null + }, + ) + """ + + def testUpdateSourceConnectorRequest(self): + """Test UpdateSourceConnectorRequest""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_update_source_connector_response.py b/test/test_update_source_connector_response.py new file mode 100644 index 0000000..5aa44d3 --- /dev/null +++ b/test/test_update_source_connector_response.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.update_source_connector_response import UpdateSourceConnectorResponse + +class TestUpdateSourceConnectorResponse(unittest.TestCase): + """UpdateSourceConnectorResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> UpdateSourceConnectorResponse: + """Test UpdateSourceConnectorResponse + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `UpdateSourceConnectorResponse` + """ + model = UpdateSourceConnectorResponse() + if include_optional: + return UpdateSourceConnectorResponse( + message = '', + data = vectorize_client.models.update_source_connector_response_data.UpdateSourceConnectorResponseData( + updated_connector = vectorize_client.models.source_connector.SourceConnector( + id = '', + type = '', + name = '', + config_doc = { + 'key' : null + }, + created_at = '', + created_by_id = '', + last_updated_by_id = '', + created_by_email = '', + last_updated_by_email = '', + error_message = '', + verification_status = '', ), + pipeline_ids = [ + '' + ], ) + ) + else: + return UpdateSourceConnectorResponse( + message = '', + data = vectorize_client.models.update_source_connector_response_data.UpdateSourceConnectorResponseData( + updated_connector = vectorize_client.models.source_connector.SourceConnector( + id = '', + type = '', + name = '', + config_doc = { + 'key' : null + }, + created_at = '', + created_by_id = '', + last_updated_by_id = '', + created_by_email = '', + last_updated_by_email = '', + error_message = '', + verification_status = '', ), + pipeline_ids = [ + '' + ], ), + ) + """ + + def testUpdateSourceConnectorResponse(self): + """Test UpdateSourceConnectorResponse""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_update_source_connector_response_data.py b/test/test_update_source_connector_response_data.py new file mode 100644 index 0000000..7234196 --- /dev/null +++ b/test/test_update_source_connector_response_data.py @@ -0,0 +1,81 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.update_source_connector_response_data import UpdateSourceConnectorResponseData + +class TestUpdateSourceConnectorResponseData(unittest.TestCase): + """UpdateSourceConnectorResponseData unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> UpdateSourceConnectorResponseData: + """Test UpdateSourceConnectorResponseData + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `UpdateSourceConnectorResponseData` + """ + model = UpdateSourceConnectorResponseData() + if include_optional: + return UpdateSourceConnectorResponseData( + updated_connector = vectorize_client.models.source_connector.SourceConnector( + id = '', + type = '', + name = '', + config_doc = { + 'key' : null + }, + created_at = '', + created_by_id = '', + last_updated_by_id = '', + created_by_email = '', + last_updated_by_email = '', + error_message = '', + verification_status = '', ), + pipeline_ids = [ + '' + ] + ) + else: + return UpdateSourceConnectorResponseData( + updated_connector = vectorize_client.models.source_connector.SourceConnector( + id = '', + type = '', + name = '', + config_doc = { + 'key' : null + }, + created_at = '', + created_by_id = '', + last_updated_by_id = '', + created_by_email = '', + last_updated_by_email = '', + error_message = '', + verification_status = '', ), + ) + """ + + def testUpdateSourceConnectorResponseData(self): + """Test UpdateSourceConnectorResponseData""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_update_user_in_source_connector_request.py b/test/test_update_user_in_source_connector_request.py new file mode 100644 index 0000000..fc11f2a --- /dev/null +++ b/test/test_update_user_in_source_connector_request.py @@ -0,0 +1,58 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.update_user_in_source_connector_request import UpdateUserInSourceConnectorRequest + +class TestUpdateUserInSourceConnectorRequest(unittest.TestCase): + """UpdateUserInSourceConnectorRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> UpdateUserInSourceConnectorRequest: + """Test UpdateUserInSourceConnectorRequest + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `UpdateUserInSourceConnectorRequest` + """ + model = UpdateUserInSourceConnectorRequest() + if include_optional: + return UpdateUserInSourceConnectorRequest( + user_id = '', + selected_files = { + 'key' : vectorize_client.models.add_user_to_source_connector_request_selected_files_value.AddUserToSourceConnectorRequest_selectedFiles_value( + name = '', + mime_type = '', ) + }, + refresh_token = '' + ) + else: + return UpdateUserInSourceConnectorRequest( + user_id = '', + ) + """ + + def testUpdateUserInSourceConnectorRequest(self): + """Test UpdateUserInSourceConnectorRequest""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_update_user_in_source_connector_response.py b/test/test_update_user_in_source_connector_response.py new file mode 100644 index 0000000..c4a8120 --- /dev/null +++ b/test/test_update_user_in_source_connector_response.py @@ -0,0 +1,52 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.update_user_in_source_connector_response import UpdateUserInSourceConnectorResponse + +class TestUpdateUserInSourceConnectorResponse(unittest.TestCase): + """UpdateUserInSourceConnectorResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> UpdateUserInSourceConnectorResponse: + """Test UpdateUserInSourceConnectorResponse + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `UpdateUserInSourceConnectorResponse` + """ + model = UpdateUserInSourceConnectorResponse() + if include_optional: + return UpdateUserInSourceConnectorResponse( + message = '' + ) + else: + return UpdateUserInSourceConnectorResponse( + message = '', + ) + """ + + def testUpdateUserInSourceConnectorResponse(self): + """Test UpdateUserInSourceConnectorResponse""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_updated_ai_platform_connector_data.py b/test/test_updated_ai_platform_connector_data.py new file mode 100644 index 0000000..dac103c --- /dev/null +++ b/test/test_updated_ai_platform_connector_data.py @@ -0,0 +1,81 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.updated_ai_platform_connector_data import UpdatedAIPlatformConnectorData + +class TestUpdatedAIPlatformConnectorData(unittest.TestCase): + """UpdatedAIPlatformConnectorData unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> UpdatedAIPlatformConnectorData: + """Test UpdatedAIPlatformConnectorData + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `UpdatedAIPlatformConnectorData` + """ + model = UpdatedAIPlatformConnectorData() + if include_optional: + return UpdatedAIPlatformConnectorData( + updated_connector = vectorize_client.models.ai_platform.AIPlatform( + id = '', + type = '', + name = '', + config_doc = { + 'key' : null + }, + created_at = '', + created_by_id = '', + last_updated_by_id = '', + created_by_email = '', + last_updated_by_email = '', + error_message = '', + verification_status = '', ), + pipeline_ids = [ + '' + ] + ) + else: + return UpdatedAIPlatformConnectorData( + updated_connector = vectorize_client.models.ai_platform.AIPlatform( + id = '', + type = '', + name = '', + config_doc = { + 'key' : null + }, + created_at = '', + created_by_id = '', + last_updated_by_id = '', + created_by_email = '', + last_updated_by_email = '', + error_message = '', + verification_status = '', ), + ) + """ + + def testUpdatedAIPlatformConnectorData(self): + """Test UpdatedAIPlatformConnectorData""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_updated_destination_connector_data.py b/test/test_updated_destination_connector_data.py new file mode 100644 index 0000000..9c2148d --- /dev/null +++ b/test/test_updated_destination_connector_data.py @@ -0,0 +1,81 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.updated_destination_connector_data import UpdatedDestinationConnectorData + +class TestUpdatedDestinationConnectorData(unittest.TestCase): + """UpdatedDestinationConnectorData unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> UpdatedDestinationConnectorData: + """Test UpdatedDestinationConnectorData + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `UpdatedDestinationConnectorData` + """ + model = UpdatedDestinationConnectorData() + if include_optional: + return UpdatedDestinationConnectorData( + updated_connector = vectorize_client.models.destination_connector.DestinationConnector( + id = '', + type = '', + name = '', + config_doc = { + 'key' : null + }, + created_at = '', + created_by_id = '', + last_updated_by_id = '', + created_by_email = '', + last_updated_by_email = '', + error_message = '', + verification_status = '', ), + pipeline_ids = [ + '' + ] + ) + else: + return UpdatedDestinationConnectorData( + updated_connector = vectorize_client.models.destination_connector.DestinationConnector( + id = '', + type = '', + name = '', + config_doc = { + 'key' : null + }, + created_at = '', + created_by_id = '', + last_updated_by_id = '', + created_by_email = '', + last_updated_by_email = '', + error_message = '', + verification_status = '', ), + ) + """ + + def testUpdatedDestinationConnectorData(self): + """Test UpdatedDestinationConnectorData""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_upload_file.py b/test/test_upload_file.py new file mode 100644 index 0000000..1e2dbf6 --- /dev/null +++ b/test/test_upload_file.py @@ -0,0 +1,65 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from vectorize_client.models.upload_file import UploadFile + +class TestUploadFile(unittest.TestCase): + """UploadFile unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> UploadFile: + """Test UploadFile + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `UploadFile` + """ + model = UploadFile() + if include_optional: + return UploadFile( + key = '', + name = '', + size = 1.337, + extension = '', + last_modified = '', + metadata = { + 'key' : '' + } + ) + else: + return UploadFile( + key = '', + name = '', + size = 1.337, + last_modified = '', + metadata = { + 'key' : '' + }, + ) + """ + + def testUploadFile(self): + """Test UploadFile""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..0ea3820 --- /dev/null +++ b/tox.ini @@ -0,0 +1,9 @@ +[tox] +envlist = py3 + +[testenv] +deps=-r{toxinidir}/requirements.txt + -r{toxinidir}/test-requirements.txt + +commands= + pytest --cov=vectorize_client diff --git a/vectorize_client/__init__.py b/vectorize_client/__init__.py new file mode 100644 index 0000000..4665a43 --- /dev/null +++ b/vectorize_client/__init__.py @@ -0,0 +1,209 @@ +# coding: utf-8 + +# flake8: noqa + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +__version__ = "1.0.0" + +# Define package exports +__all__ = [ + "PipelinesApi", + "ApiResponse", + "ApiClient", + "Configuration", + "OpenApiException", + "ApiTypeError", + "ApiValueError", + "ApiKeyError", + "ApiAttributeError", + "ApiException", + "AIPlatform", + "AIPlatformConfigSchema", + "AIPlatformSchema", + "AIPlatformType", + "AddUserFromSourceConnectorResponse", + "AddUserToSourceConnectorRequest", + "AddUserToSourceConnectorRequestSelectedFilesValue", + "AdvancedQuery", + "CreateAIPlatformConnector", + "CreateAIPlatformConnectorResponse", + "CreateDestinationConnector", + "CreateDestinationConnectorResponse", + "CreatePipelineResponse", + "CreatePipelineResponseData", + "CreateSourceConnector", + "CreateSourceConnectorResponse", + "CreatedAIPlatformConnector", + "CreatedDestinationConnector", + "CreatedSourceConnector", + "DeepResearchResult", + "DeleteAIPlatformConnectorResponse", + "DeleteDestinationConnectorResponse", + "DeleteFileResponse", + "DeletePipelineResponse", + "DeleteSourceConnectorResponse", + "DestinationConnector", + "DestinationConnectorSchema", + "DestinationConnectorType", + "Document", + "ExtractionChunkingStrategy", + "ExtractionResult", + "ExtractionResultResponse", + "ExtractionType", + "GetDeepResearchResponse", + "GetPipelineEventsResponse", + "GetPipelineMetricsResponse", + "GetPipelineResponse", + "GetPipelines400Response", + "GetPipelinesResponse", + "GetUploadFilesResponse", + "MetadataExtractionStrategy", + "MetadataExtractionStrategySchema", + "N8NConfig", + "PipelineConfigurationSchema", + "PipelineEvents", + "PipelineListSummary", + "PipelineMetrics", + "PipelineSummary", + "RemoveUserFromSourceConnectorRequest", + "RemoveUserFromSourceConnectorResponse", + "RetrieveContext", + "RetrieveContextMessage", + "RetrieveDocumentsRequest", + "RetrieveDocumentsResponse", + "ScheduleSchema", + "ScheduleSchemaType", + "SourceConnector", + "SourceConnectorSchema", + "SourceConnectorType", + "StartDeepResearchRequest", + "StartDeepResearchResponse", + "StartExtractionRequest", + "StartExtractionResponse", + "StartFileUploadRequest", + "StartFileUploadResponse", + "StartFileUploadToConnectorRequest", + "StartFileUploadToConnectorResponse", + "StartPipelineResponse", + "StopPipelineResponse", + "UpdateAIPlatformConnectorRequest", + "UpdateAIPlatformConnectorResponse", + "UpdateDestinationConnectorRequest", + "UpdateDestinationConnectorResponse", + "UpdateSourceConnectorRequest", + "UpdateSourceConnectorResponse", + "UpdateSourceConnectorResponseData", + "UpdateUserInSourceConnectorRequest", + "UpdateUserInSourceConnectorResponse", + "UpdatedAIPlatformConnectorData", + "UpdatedDestinationConnectorData", + "UploadFile", +] + +# import apis into sdk package +from vectorize_client.api.pipelines_api import PipelinesApi as PipelinesApi + +# import ApiClient +from vectorize_client.api_response import ApiResponse as ApiResponse +from vectorize_client.api_client import ApiClient as ApiClient +from vectorize_client.configuration import Configuration as Configuration +from vectorize_client.exceptions import OpenApiException as OpenApiException +from vectorize_client.exceptions import ApiTypeError as ApiTypeError +from vectorize_client.exceptions import ApiValueError as ApiValueError +from vectorize_client.exceptions import ApiKeyError as ApiKeyError +from vectorize_client.exceptions import ApiAttributeError as ApiAttributeError +from vectorize_client.exceptions import ApiException as ApiException + +# import models into sdk package +from vectorize_client.models.ai_platform import AIPlatform as AIPlatform +from vectorize_client.models.ai_platform_config_schema import AIPlatformConfigSchema as AIPlatformConfigSchema +from vectorize_client.models.ai_platform_schema import AIPlatformSchema as AIPlatformSchema +from vectorize_client.models.ai_platform_type import AIPlatformType as AIPlatformType +from vectorize_client.models.add_user_from_source_connector_response import AddUserFromSourceConnectorResponse as AddUserFromSourceConnectorResponse +from vectorize_client.models.add_user_to_source_connector_request import AddUserToSourceConnectorRequest as AddUserToSourceConnectorRequest +from vectorize_client.models.add_user_to_source_connector_request_selected_files_value import AddUserToSourceConnectorRequestSelectedFilesValue as AddUserToSourceConnectorRequestSelectedFilesValue +from vectorize_client.models.advanced_query import AdvancedQuery as AdvancedQuery +from vectorize_client.models.create_ai_platform_connector import CreateAIPlatformConnector as CreateAIPlatformConnector +from vectorize_client.models.create_ai_platform_connector_response import CreateAIPlatformConnectorResponse as CreateAIPlatformConnectorResponse +from vectorize_client.models.create_destination_connector import CreateDestinationConnector as CreateDestinationConnector +from vectorize_client.models.create_destination_connector_response import CreateDestinationConnectorResponse as CreateDestinationConnectorResponse +from vectorize_client.models.create_pipeline_response import CreatePipelineResponse as CreatePipelineResponse +from vectorize_client.models.create_pipeline_response_data import CreatePipelineResponseData as CreatePipelineResponseData +from vectorize_client.models.create_source_connector import CreateSourceConnector as CreateSourceConnector +from vectorize_client.models.create_source_connector_response import CreateSourceConnectorResponse as CreateSourceConnectorResponse +from vectorize_client.models.created_ai_platform_connector import CreatedAIPlatformConnector as CreatedAIPlatformConnector +from vectorize_client.models.created_destination_connector import CreatedDestinationConnector as CreatedDestinationConnector +from vectorize_client.models.created_source_connector import CreatedSourceConnector as CreatedSourceConnector +from vectorize_client.models.deep_research_result import DeepResearchResult as DeepResearchResult +from vectorize_client.models.delete_ai_platform_connector_response import DeleteAIPlatformConnectorResponse as DeleteAIPlatformConnectorResponse +from vectorize_client.models.delete_destination_connector_response import DeleteDestinationConnectorResponse as DeleteDestinationConnectorResponse +from vectorize_client.models.delete_file_response import DeleteFileResponse as DeleteFileResponse +from vectorize_client.models.delete_pipeline_response import DeletePipelineResponse as DeletePipelineResponse +from vectorize_client.models.delete_source_connector_response import DeleteSourceConnectorResponse as DeleteSourceConnectorResponse +from vectorize_client.models.destination_connector import DestinationConnector as DestinationConnector +from vectorize_client.models.destination_connector_schema import DestinationConnectorSchema as DestinationConnectorSchema +from vectorize_client.models.destination_connector_type import DestinationConnectorType as DestinationConnectorType +from vectorize_client.models.document import Document as Document +from vectorize_client.models.extraction_chunking_strategy import ExtractionChunkingStrategy as ExtractionChunkingStrategy +from vectorize_client.models.extraction_result import ExtractionResult as ExtractionResult +from vectorize_client.models.extraction_result_response import ExtractionResultResponse as ExtractionResultResponse +from vectorize_client.models.extraction_type import ExtractionType as ExtractionType +from vectorize_client.models.get_deep_research_response import GetDeepResearchResponse as GetDeepResearchResponse +from vectorize_client.models.get_pipeline_events_response import GetPipelineEventsResponse as GetPipelineEventsResponse +from vectorize_client.models.get_pipeline_metrics_response import GetPipelineMetricsResponse as GetPipelineMetricsResponse +from vectorize_client.models.get_pipeline_response import GetPipelineResponse as GetPipelineResponse +from vectorize_client.models.get_pipelines400_response import GetPipelines400Response as GetPipelines400Response +from vectorize_client.models.get_pipelines_response import GetPipelinesResponse as GetPipelinesResponse +from vectorize_client.models.get_upload_files_response import GetUploadFilesResponse as GetUploadFilesResponse +from vectorize_client.models.metadata_extraction_strategy import MetadataExtractionStrategy as MetadataExtractionStrategy +from vectorize_client.models.metadata_extraction_strategy_schema import MetadataExtractionStrategySchema as MetadataExtractionStrategySchema +from vectorize_client.models.n8_n_config import N8NConfig as N8NConfig +from vectorize_client.models.pipeline_configuration_schema import PipelineConfigurationSchema as PipelineConfigurationSchema +from vectorize_client.models.pipeline_events import PipelineEvents as PipelineEvents +from vectorize_client.models.pipeline_list_summary import PipelineListSummary as PipelineListSummary +from vectorize_client.models.pipeline_metrics import PipelineMetrics as PipelineMetrics +from vectorize_client.models.pipeline_summary import PipelineSummary as PipelineSummary +from vectorize_client.models.remove_user_from_source_connector_request import RemoveUserFromSourceConnectorRequest as RemoveUserFromSourceConnectorRequest +from vectorize_client.models.remove_user_from_source_connector_response import RemoveUserFromSourceConnectorResponse as RemoveUserFromSourceConnectorResponse +from vectorize_client.models.retrieve_context import RetrieveContext as RetrieveContext +from vectorize_client.models.retrieve_context_message import RetrieveContextMessage as RetrieveContextMessage +from vectorize_client.models.retrieve_documents_request import RetrieveDocumentsRequest as RetrieveDocumentsRequest +from vectorize_client.models.retrieve_documents_response import RetrieveDocumentsResponse as RetrieveDocumentsResponse +from vectorize_client.models.schedule_schema import ScheduleSchema as ScheduleSchema +from vectorize_client.models.schedule_schema_type import ScheduleSchemaType as ScheduleSchemaType +from vectorize_client.models.source_connector import SourceConnector as SourceConnector +from vectorize_client.models.source_connector_schema import SourceConnectorSchema as SourceConnectorSchema +from vectorize_client.models.source_connector_type import SourceConnectorType as SourceConnectorType +from vectorize_client.models.start_deep_research_request import StartDeepResearchRequest as StartDeepResearchRequest +from vectorize_client.models.start_deep_research_response import StartDeepResearchResponse as StartDeepResearchResponse +from vectorize_client.models.start_extraction_request import StartExtractionRequest as StartExtractionRequest +from vectorize_client.models.start_extraction_response import StartExtractionResponse as StartExtractionResponse +from vectorize_client.models.start_file_upload_request import StartFileUploadRequest as StartFileUploadRequest +from vectorize_client.models.start_file_upload_response import StartFileUploadResponse as StartFileUploadResponse +from vectorize_client.models.start_file_upload_to_connector_request import StartFileUploadToConnectorRequest as StartFileUploadToConnectorRequest +from vectorize_client.models.start_file_upload_to_connector_response import StartFileUploadToConnectorResponse as StartFileUploadToConnectorResponse +from vectorize_client.models.start_pipeline_response import StartPipelineResponse as StartPipelineResponse +from vectorize_client.models.stop_pipeline_response import StopPipelineResponse as StopPipelineResponse +from vectorize_client.models.update_ai_platform_connector_request import UpdateAIPlatformConnectorRequest as UpdateAIPlatformConnectorRequest +from vectorize_client.models.update_ai_platform_connector_response import UpdateAIPlatformConnectorResponse as UpdateAIPlatformConnectorResponse +from vectorize_client.models.update_destination_connector_request import UpdateDestinationConnectorRequest as UpdateDestinationConnectorRequest +from vectorize_client.models.update_destination_connector_response import UpdateDestinationConnectorResponse as UpdateDestinationConnectorResponse +from vectorize_client.models.update_source_connector_request import UpdateSourceConnectorRequest as UpdateSourceConnectorRequest +from vectorize_client.models.update_source_connector_response import UpdateSourceConnectorResponse as UpdateSourceConnectorResponse +from vectorize_client.models.update_source_connector_response_data import UpdateSourceConnectorResponseData as UpdateSourceConnectorResponseData +from vectorize_client.models.update_user_in_source_connector_request import UpdateUserInSourceConnectorRequest as UpdateUserInSourceConnectorRequest +from vectorize_client.models.update_user_in_source_connector_response import UpdateUserInSourceConnectorResponse as UpdateUserInSourceConnectorResponse +from vectorize_client.models.updated_ai_platform_connector_data import UpdatedAIPlatformConnectorData as UpdatedAIPlatformConnectorData +from vectorize_client.models.updated_destination_connector_data import UpdatedDestinationConnectorData as UpdatedDestinationConnectorData +from vectorize_client.models.upload_file import UploadFile as UploadFile diff --git a/vectorize_client/api/__init__.py b/vectorize_client/api/__init__.py new file mode 100644 index 0000000..ee0573e --- /dev/null +++ b/vectorize_client/api/__init__.py @@ -0,0 +1,5 @@ +# flake8: noqa + +# import apis into api package +from vectorize_client.api.pipelines_api import PipelinesApi + diff --git a/vectorize_client/api/pipelines_api.py b/vectorize_client/api/pipelines_api.py new file mode 100644 index 0000000..f84fed8 --- /dev/null +++ b/vectorize_client/api/pipelines_api.py @@ -0,0 +1,613 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated + +from pydantic import StrictStr +from vectorize_client.models.create_pipeline_response import CreatePipelineResponse +from vectorize_client.models.get_pipelines_response import GetPipelinesResponse +from vectorize_client.models.pipeline_configuration_schema import PipelineConfigurationSchema + +from vectorize_client.api_client import ApiClient, RequestSerialized +from vectorize_client.api_response import ApiResponse +from vectorize_client.rest import RESTResponseType + + +class PipelinesApi: + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None) -> None: + if api_client is None: + api_client = ApiClient.get_default() + self.api_client = api_client + + + @validate_call + def create_pipeline( + self, + organization: StrictStr, + pipeline_configuration_schema: PipelineConfigurationSchema, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> CreatePipelineResponse: + """Create a new source pipeline. Config fields for sources: Amazon S3 (AWS_S3): Check for updates every (seconds) (idle-time): number, Path Prefix (path-prefix): text, Path Metadata Regex (path-metadata-regex): text, Path Regex Group Names (path-regex-group-names): array oftext) | Azure Blob Storage (AZURE_BLOB): Polling Interval (seconds) (idle-time): number, Path Prefix (path-prefix): text, Path Metadata Regex (path-metadata-regex): text, Path Regex Group Names (path-regex-group-names): array oftext) | Confluence (CONFLUENCE): Spaces (spaces): array oftext, Root Parents (root-parents): array oftext) | Discord (DISCORD): Emoji Filter (emoji): array oftext, Author Filter (author): array oftext, Ignore Author Filter (ignore-author): array oftext, Limit (limit): number) | Dropbox (DROPBOX): Read from these folders (optional) (path-prefix): array oftext) | Google Drive OAuth (GOOGLE_DRIVE_OAUTH): Polling Interval (seconds) (idle-time): number) | Google Drive (Service Account) (GOOGLE_DRIVE): Restrict ingest to these folder URLs (optional) (root-parents): array oftext, Polling Interval (seconds) (idle-time): number) | Google Drive Multi-User (Vectorize) (GOOGLE_DRIVE_OAUTH_MULTI): Polling Interval (seconds) (idle-time): number) | Google Drive Multi-User (White Label) (GOOGLE_DRIVE_OAUTH_MULTI_CUSTOM): Polling Interval (seconds) (idle-time): number) | Firecrawl (FIRECRAWL): ) | GCP Cloud Storage (GCS): Check for updates every (seconds) (idle-time): number, Path Prefix (path-prefix): text, Path Metadata Regex (path-metadata-regex): text, Path Regex Group Names (path-regex-group-names): array oftext) | Intercom (INTERCOM): Reindex Interval (seconds) (reindexIntervalSeconds): number, Limit (limit): number, Tags (tags): array oftext) | OneDrive (ONE_DRIVE): Read starting from this folder (optional) (path-prefix): text) | SharePoint (SHAREPOINT): Site Name(s) (sites): array oftext) | Web Crawler (WEB_CRAWLER): Additional Allowed URLs or prefix(es) (allowed-domains-opt): array ofurl, Forbidden Paths (forbidden-paths): array oftext, Throttle (ms) (min-time-between-requests): number, Max Error Count (max-error-count): number, Max URLs (max-urls): number, Max Depth (max-depth): number, Reindex Interval (seconds) (reindex-interval-seconds): number) | File Upload (FILE_UPLOAD): ). Config fields for destinations: Couchbase Capella (CAPELLA): Bucket Name (bucket): text, Scope Name (scope): text, Collection Name (collection): text, Search Index Name (index): text) | DataStax Astra (DATASTAX): Collection Name (collection): text) | Elasticsearch (ELASTIC): Index Name (index): text) | Pinecone (PINECONE): Index Name (index): text, Namespace (namespace): text) | SingleStore (SINGLESTORE): Table Name (table): text) | Milvus (MILVUS): Collection Name (collection): text) | PostgreSQL (POSTGRESQL): Table Name (table): text) | Qdrant (QDRANT): Collection Name (collection): text) | Supabase (SUPABASE): Table Name (table): text) | Weaviate (WEAVIATE): Collection Name (collection): text) | Azure AI Search (AZUREAISEARCH): Index Name (index): text) | Built-in (VECTORIZE): ) | Chroma (CHROMA): Index Name (index): text) | MongoDB (MONGODB): Index Name (index): text). Config fields for AI platforms: + + + :param organization: (required) + :type organization: str + :param pipeline_configuration_schema: (required) + :type pipeline_configuration_schema: PipelineConfigurationSchema + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_pipeline_serialize( + organization=organization, + pipeline_configuration_schema=pipeline_configuration_schema, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "CreatePipelineResponse", + '400': "GetPipelines400Response", + '401': "GetPipelines400Response", + '403': "GetPipelines400Response", + '404': "GetPipelines400Response", + '500': "GetPipelines400Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_pipeline_with_http_info( + self, + organization: StrictStr, + pipeline_configuration_schema: PipelineConfigurationSchema, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[CreatePipelineResponse]: + """Create a new source pipeline. Config fields for sources: Amazon S3 (AWS_S3): Check for updates every (seconds) (idle-time): number, Path Prefix (path-prefix): text, Path Metadata Regex (path-metadata-regex): text, Path Regex Group Names (path-regex-group-names): array oftext) | Azure Blob Storage (AZURE_BLOB): Polling Interval (seconds) (idle-time): number, Path Prefix (path-prefix): text, Path Metadata Regex (path-metadata-regex): text, Path Regex Group Names (path-regex-group-names): array oftext) | Confluence (CONFLUENCE): Spaces (spaces): array oftext, Root Parents (root-parents): array oftext) | Discord (DISCORD): Emoji Filter (emoji): array oftext, Author Filter (author): array oftext, Ignore Author Filter (ignore-author): array oftext, Limit (limit): number) | Dropbox (DROPBOX): Read from these folders (optional) (path-prefix): array oftext) | Google Drive OAuth (GOOGLE_DRIVE_OAUTH): Polling Interval (seconds) (idle-time): number) | Google Drive (Service Account) (GOOGLE_DRIVE): Restrict ingest to these folder URLs (optional) (root-parents): array oftext, Polling Interval (seconds) (idle-time): number) | Google Drive Multi-User (Vectorize) (GOOGLE_DRIVE_OAUTH_MULTI): Polling Interval (seconds) (idle-time): number) | Google Drive Multi-User (White Label) (GOOGLE_DRIVE_OAUTH_MULTI_CUSTOM): Polling Interval (seconds) (idle-time): number) | Firecrawl (FIRECRAWL): ) | GCP Cloud Storage (GCS): Check for updates every (seconds) (idle-time): number, Path Prefix (path-prefix): text, Path Metadata Regex (path-metadata-regex): text, Path Regex Group Names (path-regex-group-names): array oftext) | Intercom (INTERCOM): Reindex Interval (seconds) (reindexIntervalSeconds): number, Limit (limit): number, Tags (tags): array oftext) | OneDrive (ONE_DRIVE): Read starting from this folder (optional) (path-prefix): text) | SharePoint (SHAREPOINT): Site Name(s) (sites): array oftext) | Web Crawler (WEB_CRAWLER): Additional Allowed URLs or prefix(es) (allowed-domains-opt): array ofurl, Forbidden Paths (forbidden-paths): array oftext, Throttle (ms) (min-time-between-requests): number, Max Error Count (max-error-count): number, Max URLs (max-urls): number, Max Depth (max-depth): number, Reindex Interval (seconds) (reindex-interval-seconds): number) | File Upload (FILE_UPLOAD): ). Config fields for destinations: Couchbase Capella (CAPELLA): Bucket Name (bucket): text, Scope Name (scope): text, Collection Name (collection): text, Search Index Name (index): text) | DataStax Astra (DATASTAX): Collection Name (collection): text) | Elasticsearch (ELASTIC): Index Name (index): text) | Pinecone (PINECONE): Index Name (index): text, Namespace (namespace): text) | SingleStore (SINGLESTORE): Table Name (table): text) | Milvus (MILVUS): Collection Name (collection): text) | PostgreSQL (POSTGRESQL): Table Name (table): text) | Qdrant (QDRANT): Collection Name (collection): text) | Supabase (SUPABASE): Table Name (table): text) | Weaviate (WEAVIATE): Collection Name (collection): text) | Azure AI Search (AZUREAISEARCH): Index Name (index): text) | Built-in (VECTORIZE): ) | Chroma (CHROMA): Index Name (index): text) | MongoDB (MONGODB): Index Name (index): text). Config fields for AI platforms: + + + :param organization: (required) + :type organization: str + :param pipeline_configuration_schema: (required) + :type pipeline_configuration_schema: PipelineConfigurationSchema + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_pipeline_serialize( + organization=organization, + pipeline_configuration_schema=pipeline_configuration_schema, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "CreatePipelineResponse", + '400': "GetPipelines400Response", + '401': "GetPipelines400Response", + '403': "GetPipelines400Response", + '404': "GetPipelines400Response", + '500': "GetPipelines400Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_pipeline_without_preload_content( + self, + organization: StrictStr, + pipeline_configuration_schema: PipelineConfigurationSchema, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Create a new source pipeline. Config fields for sources: Amazon S3 (AWS_S3): Check for updates every (seconds) (idle-time): number, Path Prefix (path-prefix): text, Path Metadata Regex (path-metadata-regex): text, Path Regex Group Names (path-regex-group-names): array oftext) | Azure Blob Storage (AZURE_BLOB): Polling Interval (seconds) (idle-time): number, Path Prefix (path-prefix): text, Path Metadata Regex (path-metadata-regex): text, Path Regex Group Names (path-regex-group-names): array oftext) | Confluence (CONFLUENCE): Spaces (spaces): array oftext, Root Parents (root-parents): array oftext) | Discord (DISCORD): Emoji Filter (emoji): array oftext, Author Filter (author): array oftext, Ignore Author Filter (ignore-author): array oftext, Limit (limit): number) | Dropbox (DROPBOX): Read from these folders (optional) (path-prefix): array oftext) | Google Drive OAuth (GOOGLE_DRIVE_OAUTH): Polling Interval (seconds) (idle-time): number) | Google Drive (Service Account) (GOOGLE_DRIVE): Restrict ingest to these folder URLs (optional) (root-parents): array oftext, Polling Interval (seconds) (idle-time): number) | Google Drive Multi-User (Vectorize) (GOOGLE_DRIVE_OAUTH_MULTI): Polling Interval (seconds) (idle-time): number) | Google Drive Multi-User (White Label) (GOOGLE_DRIVE_OAUTH_MULTI_CUSTOM): Polling Interval (seconds) (idle-time): number) | Firecrawl (FIRECRAWL): ) | GCP Cloud Storage (GCS): Check for updates every (seconds) (idle-time): number, Path Prefix (path-prefix): text, Path Metadata Regex (path-metadata-regex): text, Path Regex Group Names (path-regex-group-names): array oftext) | Intercom (INTERCOM): Reindex Interval (seconds) (reindexIntervalSeconds): number, Limit (limit): number, Tags (tags): array oftext) | OneDrive (ONE_DRIVE): Read starting from this folder (optional) (path-prefix): text) | SharePoint (SHAREPOINT): Site Name(s) (sites): array oftext) | Web Crawler (WEB_CRAWLER): Additional Allowed URLs or prefix(es) (allowed-domains-opt): array ofurl, Forbidden Paths (forbidden-paths): array oftext, Throttle (ms) (min-time-between-requests): number, Max Error Count (max-error-count): number, Max URLs (max-urls): number, Max Depth (max-depth): number, Reindex Interval (seconds) (reindex-interval-seconds): number) | File Upload (FILE_UPLOAD): ). Config fields for destinations: Couchbase Capella (CAPELLA): Bucket Name (bucket): text, Scope Name (scope): text, Collection Name (collection): text, Search Index Name (index): text) | DataStax Astra (DATASTAX): Collection Name (collection): text) | Elasticsearch (ELASTIC): Index Name (index): text) | Pinecone (PINECONE): Index Name (index): text, Namespace (namespace): text) | SingleStore (SINGLESTORE): Table Name (table): text) | Milvus (MILVUS): Collection Name (collection): text) | PostgreSQL (POSTGRESQL): Table Name (table): text) | Qdrant (QDRANT): Collection Name (collection): text) | Supabase (SUPABASE): Table Name (table): text) | Weaviate (WEAVIATE): Collection Name (collection): text) | Azure AI Search (AZUREAISEARCH): Index Name (index): text) | Built-in (VECTORIZE): ) | Chroma (CHROMA): Index Name (index): text) | MongoDB (MONGODB): Index Name (index): text). Config fields for AI platforms: + + + :param organization: (required) + :type organization: str + :param pipeline_configuration_schema: (required) + :type pipeline_configuration_schema: PipelineConfigurationSchema + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_pipeline_serialize( + organization=organization, + pipeline_configuration_schema=pipeline_configuration_schema, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "CreatePipelineResponse", + '400': "GetPipelines400Response", + '401': "GetPipelines400Response", + '403': "GetPipelines400Response", + '404': "GetPipelines400Response", + '500': "GetPipelines400Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_pipeline_serialize( + self, + organization, + pipeline_configuration_schema, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if organization is not None: + _path_params['organization'] = organization + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if pipeline_configuration_schema is not None: + _body_params = pipeline_configuration_schema + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'bearerAuth' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/org/{organization}/pipelines', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_pipelines( + self, + organization: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> GetPipelinesResponse: + """Get all existing pipelines + + + :param organization: (required) + :type organization: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_pipelines_serialize( + organization=organization, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "GetPipelinesResponse", + '400': "GetPipelines400Response", + '401': "GetPipelines400Response", + '403': "GetPipelines400Response", + '404': "GetPipelines400Response", + '500': "GetPipelines400Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_pipelines_with_http_info( + self, + organization: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[GetPipelinesResponse]: + """Get all existing pipelines + + + :param organization: (required) + :type organization: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_pipelines_serialize( + organization=organization, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "GetPipelinesResponse", + '400': "GetPipelines400Response", + '401': "GetPipelines400Response", + '403': "GetPipelines400Response", + '404': "GetPipelines400Response", + '500': "GetPipelines400Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_pipelines_without_preload_content( + self, + organization: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get all existing pipelines + + + :param organization: (required) + :type organization: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_pipelines_serialize( + organization=organization, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "GetPipelinesResponse", + '400': "GetPipelines400Response", + '401': "GetPipelines400Response", + '403': "GetPipelines400Response", + '404': "GetPipelines400Response", + '500': "GetPipelines400Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_pipelines_serialize( + self, + organization, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if organization is not None: + _path_params['organization'] = organization + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'bearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/org/{organization}/pipelines', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/vectorize_client/api_client.py b/vectorize_client/api_client.py new file mode 100644 index 0000000..b7ca4c8 --- /dev/null +++ b/vectorize_client/api_client.py @@ -0,0 +1,801 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import datetime +from dateutil.parser import parse +from enum import Enum +import decimal +import json +import mimetypes +import os +import re +import tempfile + +from urllib.parse import quote +from typing import Tuple, Optional, List, Dict, Union +from pydantic import SecretStr + +from vectorize_client.configuration import Configuration +from vectorize_client.api_response import ApiResponse, T as ApiResponseT +import vectorize_client.models +from vectorize_client import rest +from vectorize_client.exceptions import ( + ApiValueError, + ApiException, + BadRequestException, + UnauthorizedException, + ForbiddenException, + NotFoundException, + ServiceException +) + +RequestSerialized = Tuple[str, str, Dict[str, str], Optional[str], List[str]] + +class ApiClient: + """Generic API client for OpenAPI client library builds. + + OpenAPI generic API client. This client handles the client- + server communication, and is invariant across implementations. Specifics of + the methods and models for each application are generated from the OpenAPI + templates. + + :param configuration: .Configuration object for this client + :param header_name: a header to pass when making calls to the API. + :param header_value: a header value to pass when making calls to + the API. + :param cookie: a cookie to include in the header when making calls + to the API + """ + + PRIMITIVE_TYPES = (float, bool, bytes, str, int) + NATIVE_TYPES_MAPPING = { + 'int': int, + 'long': int, # TODO remove as only py3 is supported? + 'float': float, + 'str': str, + 'bool': bool, + 'date': datetime.date, + 'datetime': datetime.datetime, + 'decimal': decimal.Decimal, + 'object': object, + } + _pool = None + + def __init__( + self, + configuration=None, + header_name=None, + header_value=None, + cookie=None + ) -> None: + # use default configuration if none is provided + if configuration is None: + configuration = Configuration.get_default() + self.configuration = configuration + + self.rest_client = rest.RESTClientObject(configuration) + self.default_headers = {} + if header_name is not None: + self.default_headers[header_name] = header_value + self.cookie = cookie + # Set default User-Agent. + self.user_agent = 'OpenAPI-Generator/1.0.0/python' + self.client_side_validation = configuration.client_side_validation + + def __enter__(self): + return self + + def __exit__(self, exc_type, exc_value, traceback): + pass + + @property + def user_agent(self): + """User agent for this API client""" + return self.default_headers['User-Agent'] + + @user_agent.setter + def user_agent(self, value): + self.default_headers['User-Agent'] = value + + def set_default_header(self, header_name, header_value): + self.default_headers[header_name] = header_value + + + _default = None + + @classmethod + def get_default(cls): + """Return new instance of ApiClient. + + This method returns newly created, based on default constructor, + object of ApiClient class or returns a copy of default + ApiClient. + + :return: The ApiClient object. + """ + if cls._default is None: + cls._default = ApiClient() + return cls._default + + @classmethod + def set_default(cls, default): + """Set default instance of ApiClient. + + It stores default ApiClient. + + :param default: object of ApiClient. + """ + cls._default = default + + def param_serialize( + self, + method, + resource_path, + path_params=None, + query_params=None, + header_params=None, + body=None, + post_params=None, + files=None, auth_settings=None, + collection_formats=None, + _host=None, + _request_auth=None + ) -> RequestSerialized: + + """Builds the HTTP request params needed by the request. + :param method: Method to call. + :param resource_path: Path to method endpoint. + :param path_params: Path parameters in the url. + :param query_params: Query parameters in the url. + :param header_params: Header parameters to be + placed in the request header. + :param body: Request body. + :param post_params dict: Request post form parameters, + for `application/x-www-form-urlencoded`, `multipart/form-data`. + :param auth_settings list: Auth Settings names for the request. + :param files dict: key -> filename, value -> filepath, + for `multipart/form-data`. + :param collection_formats: dict of collection formats for path, query, + header, and post parameters. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :return: tuple of form (path, http_method, query_params, header_params, + body, post_params, files) + """ + + config = self.configuration + + # header parameters + header_params = header_params or {} + header_params.update(self.default_headers) + if self.cookie: + header_params['Cookie'] = self.cookie + if header_params: + header_params = self.sanitize_for_serialization(header_params) + header_params = dict( + self.parameters_to_tuples(header_params,collection_formats) + ) + + # path parameters + if path_params: + path_params = self.sanitize_for_serialization(path_params) + path_params = self.parameters_to_tuples( + path_params, + collection_formats + ) + for k, v in path_params: + # specified safe chars, encode everything + resource_path = resource_path.replace( + '{%s}' % k, + quote(str(v), safe=config.safe_chars_for_path_param) + ) + + # post parameters + if post_params or files: + post_params = post_params if post_params else [] + post_params = self.sanitize_for_serialization(post_params) + post_params = self.parameters_to_tuples( + post_params, + collection_formats + ) + if files: + post_params.extend(self.files_parameters(files)) + + # auth setting + self.update_params_for_auth( + header_params, + query_params, + auth_settings, + resource_path, + method, + body, + request_auth=_request_auth + ) + + # body + if body: + body = self.sanitize_for_serialization(body) + + # request url + if _host is None or self.configuration.ignore_operation_servers: + url = self.configuration.host + resource_path + else: + # use server/host defined in path or operation instead + url = _host + resource_path + + # query parameters + if query_params: + query_params = self.sanitize_for_serialization(query_params) + url_query = self.parameters_to_url_query( + query_params, + collection_formats + ) + url += "?" + url_query + + return method, url, header_params, body, post_params + + + def call_api( + self, + method, + url, + header_params=None, + body=None, + post_params=None, + _request_timeout=None + ) -> rest.RESTResponse: + """Makes the HTTP request (synchronous) + :param method: Method to call. + :param url: Path to method endpoint. + :param header_params: Header parameters to be + placed in the request header. + :param body: Request body. + :param post_params dict: Request post form parameters, + for `application/x-www-form-urlencoded`, `multipart/form-data`. + :param _request_timeout: timeout setting for this request. + :return: RESTResponse + """ + + try: + # perform request and return response + response_data = self.rest_client.request( + method, url, + headers=header_params, + body=body, post_params=post_params, + _request_timeout=_request_timeout + ) + + except ApiException as e: + raise e + + return response_data + + def response_deserialize( + self, + response_data: rest.RESTResponse, + response_types_map: Optional[Dict[str, ApiResponseT]]=None + ) -> ApiResponse[ApiResponseT]: + """Deserializes response into an object. + :param response_data: RESTResponse object to be deserialized. + :param response_types_map: dict of response types. + :return: ApiResponse + """ + + msg = "RESTResponse.read() must be called before passing it to response_deserialize()" + assert response_data.data is not None, msg + + response_type = response_types_map.get(str(response_data.status), None) + if not response_type and isinstance(response_data.status, int) and 100 <= response_data.status <= 599: + # if not found, look for '1XX', '2XX', etc. + response_type = response_types_map.get(str(response_data.status)[0] + "XX", None) + + # deserialize response data + response_text = None + return_data = None + try: + if response_type == "bytearray": + return_data = response_data.data + elif response_type == "file": + return_data = self.__deserialize_file(response_data) + elif response_type is not None: + match = None + content_type = response_data.getheader('content-type') + if content_type is not None: + match = re.search(r"charset=([a-zA-Z\-\d]+)[\s;]?", content_type) + encoding = match.group(1) if match else "utf-8" + response_text = response_data.data.decode(encoding) + return_data = self.deserialize(response_text, response_type, content_type) + finally: + if not 200 <= response_data.status <= 299: + raise ApiException.from_response( + http_resp=response_data, + body=response_text, + data=return_data, + ) + + return ApiResponse( + status_code = response_data.status, + data = return_data, + headers = response_data.getheaders(), + raw_data = response_data.data + ) + + def sanitize_for_serialization(self, obj): + """Builds a JSON POST object. + + If obj is None, return None. + If obj is SecretStr, return obj.get_secret_value() + If obj is str, int, long, float, bool, return directly. + If obj is datetime.datetime, datetime.date + convert to string in iso8601 format. + If obj is decimal.Decimal return string representation. + If obj is list, sanitize each element in the list. + If obj is dict, return the dict. + If obj is OpenAPI model, return the properties dict. + + :param obj: The data to serialize. + :return: The serialized form of data. + """ + if obj is None: + return None + elif isinstance(obj, Enum): + return obj.value + elif isinstance(obj, SecretStr): + return obj.get_secret_value() + elif isinstance(obj, self.PRIMITIVE_TYPES): + return obj + elif isinstance(obj, list): + return [ + self.sanitize_for_serialization(sub_obj) for sub_obj in obj + ] + elif isinstance(obj, tuple): + return tuple( + self.sanitize_for_serialization(sub_obj) for sub_obj in obj + ) + elif isinstance(obj, (datetime.datetime, datetime.date)): + return obj.isoformat() + elif isinstance(obj, decimal.Decimal): + return str(obj) + + elif isinstance(obj, dict): + obj_dict = obj + else: + # Convert model obj to dict except + # attributes `openapi_types`, `attribute_map` + # and attributes which value is not None. + # Convert attribute name to json key in + # model definition for request. + if hasattr(obj, 'to_dict') and callable(getattr(obj, 'to_dict')): + obj_dict = obj.to_dict() + else: + obj_dict = obj.__dict__ + + if isinstance(obj_dict, list): + # here we handle instances that can either be a list or something else, and only became a real list by calling to_dict() + return self.sanitize_for_serialization(obj_dict) + + return { + key: self.sanitize_for_serialization(val) + for key, val in obj_dict.items() + } + + def deserialize(self, response_text: str, response_type: str, content_type: Optional[str]): + """Deserializes response into an object. + + :param response: RESTResponse object to be deserialized. + :param response_type: class literal for + deserialized object, or string of class name. + :param content_type: content type of response. + + :return: deserialized object. + """ + + # fetch data from response object + if content_type is None: + try: + data = json.loads(response_text) + except ValueError: + data = response_text + elif re.match(r'^application/(json|[\w!#$&.+-^_]+\+json)\s*(;|$)', content_type, re.IGNORECASE): + if response_text == "": + data = "" + else: + data = json.loads(response_text) + elif re.match(r'^text\/[a-z.+-]+\s*(;|$)', content_type, re.IGNORECASE): + data = response_text + else: + raise ApiException( + status=0, + reason="Unsupported content type: {0}".format(content_type) + ) + + return self.__deserialize(data, response_type) + + def __deserialize(self, data, klass): + """Deserializes dict, list, str into an object. + + :param data: dict, list or str. + :param klass: class literal, or string of class name. + + :return: object. + """ + if data is None: + return None + + if isinstance(klass, str): + if klass.startswith('List['): + m = re.match(r'List\[(.*)]', klass) + assert m is not None, "Malformed List type definition" + sub_kls = m.group(1) + return [self.__deserialize(sub_data, sub_kls) + for sub_data in data] + + if klass.startswith('Dict['): + m = re.match(r'Dict\[([^,]*), (.*)]', klass) + assert m is not None, "Malformed Dict type definition" + sub_kls = m.group(2) + return {k: self.__deserialize(v, sub_kls) + for k, v in data.items()} + + # convert str to class + if klass in self.NATIVE_TYPES_MAPPING: + klass = self.NATIVE_TYPES_MAPPING[klass] + else: + klass = getattr(vectorize_client.models, klass) + + if klass in self.PRIMITIVE_TYPES: + return self.__deserialize_primitive(data, klass) + elif klass == object: + return self.__deserialize_object(data) + elif klass == datetime.date: + return self.__deserialize_date(data) + elif klass == datetime.datetime: + return self.__deserialize_datetime(data) + elif klass == decimal.Decimal: + return decimal.Decimal(data) + elif issubclass(klass, Enum): + return self.__deserialize_enum(data, klass) + else: + return self.__deserialize_model(data, klass) + + def parameters_to_tuples(self, params, collection_formats): + """Get parameters as list of tuples, formatting collections. + + :param params: Parameters as dict or list of two-tuples + :param dict collection_formats: Parameter collection formats + :return: Parameters as list of tuples, collections formatted + """ + new_params: List[Tuple[str, str]] = [] + if collection_formats is None: + collection_formats = {} + for k, v in params.items() if isinstance(params, dict) else params: + if k in collection_formats: + collection_format = collection_formats[k] + if collection_format == 'multi': + new_params.extend((k, value) for value in v) + else: + if collection_format == 'ssv': + delimiter = ' ' + elif collection_format == 'tsv': + delimiter = '\t' + elif collection_format == 'pipes': + delimiter = '|' + else: # csv is the default + delimiter = ',' + new_params.append( + (k, delimiter.join(str(value) for value in v))) + else: + new_params.append((k, v)) + return new_params + + def parameters_to_url_query(self, params, collection_formats): + """Get parameters as list of tuples, formatting collections. + + :param params: Parameters as dict or list of two-tuples + :param dict collection_formats: Parameter collection formats + :return: URL query string (e.g. a=Hello%20World&b=123) + """ + new_params: List[Tuple[str, str]] = [] + if collection_formats is None: + collection_formats = {} + for k, v in params.items() if isinstance(params, dict) else params: + if isinstance(v, bool): + v = str(v).lower() + if isinstance(v, (int, float)): + v = str(v) + if isinstance(v, dict): + v = json.dumps(v) + + if k in collection_formats: + collection_format = collection_formats[k] + if collection_format == 'multi': + new_params.extend((k, quote(str(value))) for value in v) + else: + if collection_format == 'ssv': + delimiter = ' ' + elif collection_format == 'tsv': + delimiter = '\t' + elif collection_format == 'pipes': + delimiter = '|' + else: # csv is the default + delimiter = ',' + new_params.append( + (k, delimiter.join(quote(str(value)) for value in v)) + ) + else: + new_params.append((k, quote(str(v)))) + + return "&".join(["=".join(map(str, item)) for item in new_params]) + + def files_parameters( + self, + files: Dict[str, Union[str, bytes, List[str], List[bytes], Tuple[str, bytes]]], + ): + """Builds form parameters. + + :param files: File parameters. + :return: Form parameters with files. + """ + params = [] + for k, v in files.items(): + if isinstance(v, str): + with open(v, 'rb') as f: + filename = os.path.basename(f.name) + filedata = f.read() + elif isinstance(v, bytes): + filename = k + filedata = v + elif isinstance(v, tuple): + filename, filedata = v + elif isinstance(v, list): + for file_param in v: + params.extend(self.files_parameters({k: file_param})) + continue + else: + raise ValueError("Unsupported file value") + mimetype = ( + mimetypes.guess_type(filename)[0] + or 'application/octet-stream' + ) + params.append( + tuple([k, tuple([filename, filedata, mimetype])]) + ) + return params + + def select_header_accept(self, accepts: List[str]) -> Optional[str]: + """Returns `Accept` based on an array of accepts provided. + + :param accepts: List of headers. + :return: Accept (e.g. application/json). + """ + if not accepts: + return None + + for accept in accepts: + if re.search('json', accept, re.IGNORECASE): + return accept + + return accepts[0] + + def select_header_content_type(self, content_types): + """Returns `Content-Type` based on an array of content_types provided. + + :param content_types: List of content-types. + :return: Content-Type (e.g. application/json). + """ + if not content_types: + return None + + for content_type in content_types: + if re.search('json', content_type, re.IGNORECASE): + return content_type + + return content_types[0] + + def update_params_for_auth( + self, + headers, + queries, + auth_settings, + resource_path, + method, + body, + request_auth=None + ) -> None: + """Updates header and query params based on authentication setting. + + :param headers: Header parameters dict to be updated. + :param queries: Query parameters tuple list to be updated. + :param auth_settings: Authentication setting identifiers list. + :resource_path: A string representation of the HTTP request resource path. + :method: A string representation of the HTTP request method. + :body: A object representing the body of the HTTP request. + The object type is the return value of sanitize_for_serialization(). + :param request_auth: if set, the provided settings will + override the token in the configuration. + """ + if not auth_settings: + return + + if request_auth: + self._apply_auth_params( + headers, + queries, + resource_path, + method, + body, + request_auth + ) + else: + for auth in auth_settings: + auth_setting = self.configuration.auth_settings().get(auth) + if auth_setting: + self._apply_auth_params( + headers, + queries, + resource_path, + method, + body, + auth_setting + ) + + def _apply_auth_params( + self, + headers, + queries, + resource_path, + method, + body, + auth_setting + ) -> None: + """Updates the request parameters based on a single auth_setting + + :param headers: Header parameters dict to be updated. + :param queries: Query parameters tuple list to be updated. + :resource_path: A string representation of the HTTP request resource path. + :method: A string representation of the HTTP request method. + :body: A object representing the body of the HTTP request. + The object type is the return value of sanitize_for_serialization(). + :param auth_setting: auth settings for the endpoint + """ + if auth_setting['in'] == 'cookie': + headers['Cookie'] = auth_setting['value'] + elif auth_setting['in'] == 'header': + if auth_setting['type'] != 'http-signature': + headers[auth_setting['key']] = auth_setting['value'] + elif auth_setting['in'] == 'query': + queries.append((auth_setting['key'], auth_setting['value'])) + else: + raise ApiValueError( + 'Authentication token must be in `query` or `header`' + ) + + def __deserialize_file(self, response): + """Deserializes body to file + + Saves response body into a file in a temporary folder, + using the filename from the `Content-Disposition` header if provided. + + handle file downloading + save response body into a tmp file and return the instance + + :param response: RESTResponse. + :return: file path. + """ + fd, path = tempfile.mkstemp(dir=self.configuration.temp_folder_path) + os.close(fd) + os.remove(path) + + content_disposition = response.getheader("Content-Disposition") + if content_disposition: + m = re.search( + r'filename=[\'"]?([^\'"\s]+)[\'"]?', + content_disposition + ) + assert m is not None, "Unexpected 'content-disposition' header value" + filename = m.group(1) + path = os.path.join(os.path.dirname(path), filename) + + with open(path, "wb") as f: + f.write(response.data) + + return path + + def __deserialize_primitive(self, data, klass): + """Deserializes string to primitive type. + + :param data: str. + :param klass: class literal. + + :return: int, long, float, str, bool. + """ + try: + return klass(data) + except UnicodeEncodeError: + return str(data) + except TypeError: + return data + + def __deserialize_object(self, value): + """Return an original value. + + :return: object. + """ + return value + + def __deserialize_date(self, string): + """Deserializes string to date. + + :param string: str. + :return: date. + """ + try: + return parse(string).date() + except ImportError: + return string + except ValueError: + raise rest.ApiException( + status=0, + reason="Failed to parse `{0}` as date object".format(string) + ) + + def __deserialize_datetime(self, string): + """Deserializes string to datetime. + + The string should be in iso8601 datetime format. + + :param string: str. + :return: datetime. + """ + try: + return parse(string) + except ImportError: + return string + except ValueError: + raise rest.ApiException( + status=0, + reason=( + "Failed to parse `{0}` as datetime object" + .format(string) + ) + ) + + def __deserialize_enum(self, data, klass): + """Deserializes primitive type to enum. + + :param data: primitive type. + :param klass: class literal. + :return: enum value. + """ + try: + return klass(data) + except ValueError: + raise rest.ApiException( + status=0, + reason=( + "Failed to parse `{0}` as `{1}`" + .format(data, klass) + ) + ) + + def __deserialize_model(self, data, klass): + """Deserializes list or dict to model. + + :param data: dict, list. + :param klass: class literal. + :return: model object. + """ + + return klass.from_dict(data) diff --git a/vectorize_client/api_response.py b/vectorize_client/api_response.py new file mode 100644 index 0000000..9bc7c11 --- /dev/null +++ b/vectorize_client/api_response.py @@ -0,0 +1,21 @@ +"""API response object.""" + +from __future__ import annotations +from typing import Optional, Generic, Mapping, TypeVar +from pydantic import Field, StrictInt, StrictBytes, BaseModel + +T = TypeVar("T") + +class ApiResponse(BaseModel, Generic[T]): + """ + API response object + """ + + status_code: StrictInt = Field(description="HTTP status code") + headers: Optional[Mapping[str, str]] = Field(None, description="HTTP headers") + data: T = Field(description="Deserialized data given the data type") + raw_data: StrictBytes = Field(description="Raw data (HTTP response body)") + + model_config = { + "arbitrary_types_allowed": True + } diff --git a/vectorize_client/configuration.py b/vectorize_client/configuration.py new file mode 100644 index 0000000..ab09b9a --- /dev/null +++ b/vectorize_client/configuration.py @@ -0,0 +1,582 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import copy +import http.client as httplib +import logging +from logging import FileHandler +import multiprocessing +import sys +from typing import Any, ClassVar, Dict, List, Literal, Optional, TypedDict, Union +from typing_extensions import NotRequired, Self + +import urllib3 + + +JSON_SCHEMA_VALIDATION_KEYWORDS = { + 'multipleOf', 'maximum', 'exclusiveMaximum', + 'minimum', 'exclusiveMinimum', 'maxLength', + 'minLength', 'pattern', 'maxItems', 'minItems' +} + +ServerVariablesT = Dict[str, str] + +GenericAuthSetting = TypedDict( + "GenericAuthSetting", + { + "type": str, + "in": str, + "key": str, + "value": str, + }, +) + + +OAuth2AuthSetting = TypedDict( + "OAuth2AuthSetting", + { + "type": Literal["oauth2"], + "in": Literal["header"], + "key": Literal["Authorization"], + "value": str, + }, +) + + +APIKeyAuthSetting = TypedDict( + "APIKeyAuthSetting", + { + "type": Literal["api_key"], + "in": str, + "key": str, + "value": Optional[str], + }, +) + + +BasicAuthSetting = TypedDict( + "BasicAuthSetting", + { + "type": Literal["basic"], + "in": Literal["header"], + "key": Literal["Authorization"], + "value": Optional[str], + }, +) + + +BearerFormatAuthSetting = TypedDict( + "BearerFormatAuthSetting", + { + "type": Literal["bearer"], + "in": Literal["header"], + "format": Literal["JWT"], + "key": Literal["Authorization"], + "value": str, + }, +) + + +BearerAuthSetting = TypedDict( + "BearerAuthSetting", + { + "type": Literal["bearer"], + "in": Literal["header"], + "key": Literal["Authorization"], + "value": str, + }, +) + + +HTTPSignatureAuthSetting = TypedDict( + "HTTPSignatureAuthSetting", + { + "type": Literal["http-signature"], + "in": Literal["header"], + "key": Literal["Authorization"], + "value": None, + }, +) + + +AuthSettings = TypedDict( + "AuthSettings", + { + "bearerAuth": BearerFormatAuthSetting, + }, + total=False, +) + + +class HostSettingVariable(TypedDict): + description: str + default_value: str + enum_values: List[str] + + +class HostSetting(TypedDict): + url: str + description: str + variables: NotRequired[Dict[str, HostSettingVariable]] + + +class Configuration: + """This class contains various settings of the API client. + + :param host: Base url. + :param ignore_operation_servers + Boolean to ignore operation servers for the API client. + Config will use `host` as the base url regardless of the operation servers. + :param api_key: Dict to store API key(s). + Each entry in the dict specifies an API key. + The dict key is the name of the security scheme in the OAS specification. + The dict value is the API key secret. + :param api_key_prefix: Dict to store API prefix (e.g. Bearer). + The dict key is the name of the security scheme in the OAS specification. + The dict value is an API key prefix when generating the auth data. + :param username: Username for HTTP basic authentication. + :param password: Password for HTTP basic authentication. + :param access_token: Access token. + :param server_index: Index to servers configuration. + :param server_variables: Mapping with string values to replace variables in + templated server configuration. The validation of enums is performed for + variables with defined enum values before. + :param server_operation_index: Mapping from operation ID to an index to server + configuration. + :param server_operation_variables: Mapping from operation ID to a mapping with + string values to replace variables in templated server configuration. + The validation of enums is performed for variables with defined enum + values before. + :param ssl_ca_cert: str - the path to a file of concatenated CA certificates + in PEM format. + :param retries: Number of retries for API requests. + :param ca_cert_data: verify the peer using concatenated CA certificate data + in PEM (str) or DER (bytes) format. + + :Example: + """ + + _default: ClassVar[Optional[Self]] = None + + def __init__( + self, + host: Optional[str]=None, + api_key: Optional[Dict[str, str]]=None, + api_key_prefix: Optional[Dict[str, str]]=None, + username: Optional[str]=None, + password: Optional[str]=None, + access_token: Optional[str]=None, + server_index: Optional[int]=None, + server_variables: Optional[ServerVariablesT]=None, + server_operation_index: Optional[Dict[int, int]]=None, + server_operation_variables: Optional[Dict[int, ServerVariablesT]]=None, + ignore_operation_servers: bool=False, + ssl_ca_cert: Optional[str]=None, + retries: Optional[int] = None, + ca_cert_data: Optional[Union[str, bytes]] = None, + *, + debug: Optional[bool] = None, + ) -> None: + """Constructor + """ + self._base_path = "https://api.vectorize.io/v1" if host is None else host + """Default Base url + """ + self.server_index = 0 if server_index is None and host is None else server_index + self.server_operation_index = server_operation_index or {} + """Default server index + """ + self.server_variables = server_variables or {} + self.server_operation_variables = server_operation_variables or {} + """Default server variables + """ + self.ignore_operation_servers = ignore_operation_servers + """Ignore operation servers + """ + self.temp_folder_path = None + """Temp file folder for downloading files + """ + # Authentication Settings + self.api_key = {} + if api_key: + self.api_key = api_key + """dict to store API key(s) + """ + self.api_key_prefix = {} + if api_key_prefix: + self.api_key_prefix = api_key_prefix + """dict to store API prefix (e.g. Bearer) + """ + self.refresh_api_key_hook = None + """function hook to refresh API key if expired + """ + self.username = username + """Username for HTTP basic authentication + """ + self.password = password + """Password for HTTP basic authentication + """ + self.access_token = access_token + """Access token + """ + self.logger = {} + """Logging Settings + """ + self.logger["package_logger"] = logging.getLogger("vectorize_client") + self.logger["urllib3_logger"] = logging.getLogger("urllib3") + self.logger_format = '%(asctime)s %(levelname)s %(message)s' + """Log format + """ + self.logger_stream_handler = None + """Log stream handler + """ + self.logger_file_handler: Optional[FileHandler] = None + """Log file handler + """ + self.logger_file = None + """Debug file location + """ + if debug is not None: + self.debug = debug + else: + self.__debug = False + """Debug switch + """ + + self.verify_ssl = True + """SSL/TLS verification + Set this to false to skip verifying SSL certificate when calling API + from https server. + """ + self.ssl_ca_cert = ssl_ca_cert + """Set this to customize the certificate file to verify the peer. + """ + self.ca_cert_data = ca_cert_data + """Set this to verify the peer using PEM (str) or DER (bytes) + certificate data. + """ + self.cert_file = None + """client certificate file + """ + self.key_file = None + """client key file + """ + self.assert_hostname = None + """Set this to True/False to enable/disable SSL hostname verification. + """ + self.tls_server_name = None + """SSL/TLS Server Name Indication (SNI) + Set this to the SNI value expected by the server. + """ + + self.connection_pool_maxsize = multiprocessing.cpu_count() * 5 + """urllib3 connection pool's maximum number of connections saved + per pool. urllib3 uses 1 connection as default value, but this is + not the best value when you are making a lot of possibly parallel + requests to the same host, which is often the case here. + cpu_count * 5 is used as default value to increase performance. + """ + + self.proxy: Optional[str] = None + """Proxy URL + """ + self.proxy_headers = None + """Proxy headers + """ + self.safe_chars_for_path_param = '' + """Safe chars for path_param + """ + self.retries = retries + """Adding retries to override urllib3 default value 3 + """ + # Enable client side validation + self.client_side_validation = True + + self.socket_options = None + """Options to pass down to the underlying urllib3 socket + """ + + self.datetime_format = "%Y-%m-%dT%H:%M:%S.%f%z" + """datetime format + """ + + self.date_format = "%Y-%m-%d" + """date format + """ + + def __deepcopy__(self, memo: Dict[int, Any]) -> Self: + cls = self.__class__ + result = cls.__new__(cls) + memo[id(self)] = result + for k, v in self.__dict__.items(): + if k not in ('logger', 'logger_file_handler'): + setattr(result, k, copy.deepcopy(v, memo)) + # shallow copy of loggers + result.logger = copy.copy(self.logger) + # use setters to configure loggers + result.logger_file = self.logger_file + result.debug = self.debug + return result + + def __setattr__(self, name: str, value: Any) -> None: + object.__setattr__(self, name, value) + + @classmethod + def set_default(cls, default: Optional[Self]) -> None: + """Set default instance of configuration. + + It stores default configuration, which can be + returned by get_default_copy method. + + :param default: object of Configuration + """ + cls._default = default + + @classmethod + def get_default_copy(cls) -> Self: + """Deprecated. Please use `get_default` instead. + + Deprecated. Please use `get_default` instead. + + :return: The configuration object. + """ + return cls.get_default() + + @classmethod + def get_default(cls) -> Self: + """Return the default configuration. + + This method returns newly created, based on default constructor, + object of Configuration class or returns a copy of default + configuration. + + :return: The configuration object. + """ + if cls._default is None: + cls._default = cls() + return cls._default + + @property + def logger_file(self) -> Optional[str]: + """The logger file. + + If the logger_file is None, then add stream handler and remove file + handler. Otherwise, add file handler and remove stream handler. + + :param value: The logger_file path. + :type: str + """ + return self.__logger_file + + @logger_file.setter + def logger_file(self, value: Optional[str]) -> None: + """The logger file. + + If the logger_file is None, then add stream handler and remove file + handler. Otherwise, add file handler and remove stream handler. + + :param value: The logger_file path. + :type: str + """ + self.__logger_file = value + if self.__logger_file: + # If set logging file, + # then add file handler and remove stream handler. + self.logger_file_handler = logging.FileHandler(self.__logger_file) + self.logger_file_handler.setFormatter(self.logger_formatter) + for _, logger in self.logger.items(): + logger.addHandler(self.logger_file_handler) + + @property + def debug(self) -> bool: + """Debug status + + :param value: The debug status, True or False. + :type: bool + """ + return self.__debug + + @debug.setter + def debug(self, value: bool) -> None: + """Debug status + + :param value: The debug status, True or False. + :type: bool + """ + self.__debug = value + if self.__debug: + # if debug status is True, turn on debug logging + for _, logger in self.logger.items(): + logger.setLevel(logging.DEBUG) + # turn on httplib debug + httplib.HTTPConnection.debuglevel = 1 + else: + # if debug status is False, turn off debug logging, + # setting log level to default `logging.WARNING` + for _, logger in self.logger.items(): + logger.setLevel(logging.WARNING) + # turn off httplib debug + httplib.HTTPConnection.debuglevel = 0 + + @property + def logger_format(self) -> str: + """The logger format. + + The logger_formatter will be updated when sets logger_format. + + :param value: The format string. + :type: str + """ + return self.__logger_format + + @logger_format.setter + def logger_format(self, value: str) -> None: + """The logger format. + + The logger_formatter will be updated when sets logger_format. + + :param value: The format string. + :type: str + """ + self.__logger_format = value + self.logger_formatter = logging.Formatter(self.__logger_format) + + def get_api_key_with_prefix(self, identifier: str, alias: Optional[str]=None) -> Optional[str]: + """Gets API key (with prefix if set). + + :param identifier: The identifier of apiKey. + :param alias: The alternative identifier of apiKey. + :return: The token for api key authentication. + """ + if self.refresh_api_key_hook is not None: + self.refresh_api_key_hook(self) + key = self.api_key.get(identifier, self.api_key.get(alias) if alias is not None else None) + if key: + prefix = self.api_key_prefix.get(identifier) + if prefix: + return "%s %s" % (prefix, key) + else: + return key + + return None + + def get_basic_auth_token(self) -> Optional[str]: + """Gets HTTP basic authentication header (string). + + :return: The token for basic HTTP authentication. + """ + username = "" + if self.username is not None: + username = self.username + password = "" + if self.password is not None: + password = self.password + return urllib3.util.make_headers( + basic_auth=username + ':' + password + ).get('authorization') + + def auth_settings(self)-> AuthSettings: + """Gets Auth Settings dict for api client. + + :return: The Auth Settings information dict. + """ + auth: AuthSettings = {} + if self.access_token is not None: + auth['bearerAuth'] = { + 'type': 'bearer', + 'in': 'header', + 'format': 'JWT', + 'key': 'Authorization', + 'value': 'Bearer ' + self.access_token + } + return auth + + def to_debug_report(self) -> str: + """Gets the essential information for debugging. + + :return: The report for debugging. + """ + return "Python SDK Debug Report:\n"\ + "OS: {env}\n"\ + "Python Version: {pyversion}\n"\ + "Version of the API: 0.0.1\n"\ + "SDK Package Version: 1.0.0".\ + format(env=sys.platform, pyversion=sys.version) + + def get_host_settings(self) -> List[HostSetting]: + """Gets an array of host settings + + :return: An array of host settings + """ + return [ + { + 'url': "https://api.vectorize.io/v1", + 'description': "Vectorize API", + } + ] + + def get_host_from_settings( + self, + index: Optional[int], + variables: Optional[ServerVariablesT]=None, + servers: Optional[List[HostSetting]]=None, + ) -> str: + """Gets host URL based on the index and variables + :param index: array index of the host settings + :param variables: hash of variable and the corresponding value + :param servers: an array of host settings or None + :return: URL based on host settings + """ + if index is None: + return self._base_path + + variables = {} if variables is None else variables + servers = self.get_host_settings() if servers is None else servers + + try: + server = servers[index] + except IndexError: + raise ValueError( + "Invalid index {0} when selecting the host settings. " + "Must be less than {1}".format(index, len(servers))) + + url = server['url'] + + # go through variables and replace placeholders + for variable_name, variable in server.get('variables', {}).items(): + used_value = variables.get( + variable_name, variable['default_value']) + + if 'enum_values' in variable \ + and used_value not in variable['enum_values']: + raise ValueError( + "The variable `{0}` in the host URL has invalid value " + "{1}. Must be {2}.".format( + variable_name, variables[variable_name], + variable['enum_values'])) + + url = url.replace("{" + variable_name + "}", used_value) + + return url + + @property + def host(self) -> str: + """Return generated host.""" + return self.get_host_from_settings(self.server_index, variables=self.server_variables) + + @host.setter + def host(self, value: str) -> None: + """Fix base path.""" + self._base_path = value + self.server_index = None diff --git a/vectorize_client/exceptions.py b/vectorize_client/exceptions.py new file mode 100644 index 0000000..1ebc80d --- /dev/null +++ b/vectorize_client/exceptions.py @@ -0,0 +1,216 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +from typing import Any, Optional +from typing_extensions import Self + +class OpenApiException(Exception): + """The base exception class for all OpenAPIExceptions""" + + +class ApiTypeError(OpenApiException, TypeError): + def __init__(self, msg, path_to_item=None, valid_classes=None, + key_type=None) -> None: + """ Raises an exception for TypeErrors + + Args: + msg (str): the exception message + + Keyword Args: + path_to_item (list): a list of keys an indices to get to the + current_item + None if unset + valid_classes (tuple): the primitive classes that current item + should be an instance of + None if unset + key_type (bool): False if our value is a value in a dict + True if it is a key in a dict + False if our item is an item in a list + None if unset + """ + self.path_to_item = path_to_item + self.valid_classes = valid_classes + self.key_type = key_type + full_msg = msg + if path_to_item: + full_msg = "{0} at {1}".format(msg, render_path(path_to_item)) + super(ApiTypeError, self).__init__(full_msg) + + +class ApiValueError(OpenApiException, ValueError): + def __init__(self, msg, path_to_item=None) -> None: + """ + Args: + msg (str): the exception message + + Keyword Args: + path_to_item (list) the path to the exception in the + received_data dict. None if unset + """ + + self.path_to_item = path_to_item + full_msg = msg + if path_to_item: + full_msg = "{0} at {1}".format(msg, render_path(path_to_item)) + super(ApiValueError, self).__init__(full_msg) + + +class ApiAttributeError(OpenApiException, AttributeError): + def __init__(self, msg, path_to_item=None) -> None: + """ + Raised when an attribute reference or assignment fails. + + Args: + msg (str): the exception message + + Keyword Args: + path_to_item (None/list) the path to the exception in the + received_data dict + """ + self.path_to_item = path_to_item + full_msg = msg + if path_to_item: + full_msg = "{0} at {1}".format(msg, render_path(path_to_item)) + super(ApiAttributeError, self).__init__(full_msg) + + +class ApiKeyError(OpenApiException, KeyError): + def __init__(self, msg, path_to_item=None) -> None: + """ + Args: + msg (str): the exception message + + Keyword Args: + path_to_item (None/list) the path to the exception in the + received_data dict + """ + self.path_to_item = path_to_item + full_msg = msg + if path_to_item: + full_msg = "{0} at {1}".format(msg, render_path(path_to_item)) + super(ApiKeyError, self).__init__(full_msg) + + +class ApiException(OpenApiException): + + def __init__( + self, + status=None, + reason=None, + http_resp=None, + *, + body: Optional[str] = None, + data: Optional[Any] = None, + ) -> None: + self.status = status + self.reason = reason + self.body = body + self.data = data + self.headers = None + + if http_resp: + if self.status is None: + self.status = http_resp.status + if self.reason is None: + self.reason = http_resp.reason + if self.body is None: + try: + self.body = http_resp.data.decode('utf-8') + except Exception: + pass + self.headers = http_resp.getheaders() + + @classmethod + def from_response( + cls, + *, + http_resp, + body: Optional[str], + data: Optional[Any], + ) -> Self: + if http_resp.status == 400: + raise BadRequestException(http_resp=http_resp, body=body, data=data) + + if http_resp.status == 401: + raise UnauthorizedException(http_resp=http_resp, body=body, data=data) + + if http_resp.status == 403: + raise ForbiddenException(http_resp=http_resp, body=body, data=data) + + if http_resp.status == 404: + raise NotFoundException(http_resp=http_resp, body=body, data=data) + + # Added new conditions for 409 and 422 + if http_resp.status == 409: + raise ConflictException(http_resp=http_resp, body=body, data=data) + + if http_resp.status == 422: + raise UnprocessableEntityException(http_resp=http_resp, body=body, data=data) + + if 500 <= http_resp.status <= 599: + raise ServiceException(http_resp=http_resp, body=body, data=data) + raise ApiException(http_resp=http_resp, body=body, data=data) + + def __str__(self): + """Custom error messages for exception""" + error_message = "({0})\n"\ + "Reason: {1}\n".format(self.status, self.reason) + if self.headers: + error_message += "HTTP response headers: {0}\n".format( + self.headers) + + if self.data or self.body: + error_message += "HTTP response body: {0}\n".format(self.data or self.body) + + return error_message + + +class BadRequestException(ApiException): + pass + + +class NotFoundException(ApiException): + pass + + +class UnauthorizedException(ApiException): + pass + + +class ForbiddenException(ApiException): + pass + + +class ServiceException(ApiException): + pass + + +class ConflictException(ApiException): + """Exception for HTTP 409 Conflict.""" + pass + + +class UnprocessableEntityException(ApiException): + """Exception for HTTP 422 Unprocessable Entity.""" + pass + + +def render_path(path_to_item): + """Returns a string representation of a path""" + result = "" + for pth in path_to_item: + if isinstance(pth, int): + result += "[{0}]".format(pth) + else: + result += "['{0}']".format(pth) + return result diff --git a/vectorize_client/models/__init__.py b/vectorize_client/models/__init__.py new file mode 100644 index 0000000..8567be3 --- /dev/null +++ b/vectorize_client/models/__init__.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +# flake8: noqa +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +# import models into model package +from vectorize_client.models.ai_platform import AIPlatform +from vectorize_client.models.ai_platform_config_schema import AIPlatformConfigSchema +from vectorize_client.models.ai_platform_schema import AIPlatformSchema +from vectorize_client.models.ai_platform_type import AIPlatformType +from vectorize_client.models.add_user_from_source_connector_response import AddUserFromSourceConnectorResponse +from vectorize_client.models.add_user_to_source_connector_request import AddUserToSourceConnectorRequest +from vectorize_client.models.add_user_to_source_connector_request_selected_files_value import AddUserToSourceConnectorRequestSelectedFilesValue +from vectorize_client.models.advanced_query import AdvancedQuery +from vectorize_client.models.create_ai_platform_connector import CreateAIPlatformConnector +from vectorize_client.models.create_ai_platform_connector_response import CreateAIPlatformConnectorResponse +from vectorize_client.models.create_destination_connector import CreateDestinationConnector +from vectorize_client.models.create_destination_connector_response import CreateDestinationConnectorResponse +from vectorize_client.models.create_pipeline_response import CreatePipelineResponse +from vectorize_client.models.create_pipeline_response_data import CreatePipelineResponseData +from vectorize_client.models.create_source_connector import CreateSourceConnector +from vectorize_client.models.create_source_connector_response import CreateSourceConnectorResponse +from vectorize_client.models.created_ai_platform_connector import CreatedAIPlatformConnector +from vectorize_client.models.created_destination_connector import CreatedDestinationConnector +from vectorize_client.models.created_source_connector import CreatedSourceConnector +from vectorize_client.models.deep_research_result import DeepResearchResult +from vectorize_client.models.delete_ai_platform_connector_response import DeleteAIPlatformConnectorResponse +from vectorize_client.models.delete_destination_connector_response import DeleteDestinationConnectorResponse +from vectorize_client.models.delete_file_response import DeleteFileResponse +from vectorize_client.models.delete_pipeline_response import DeletePipelineResponse +from vectorize_client.models.delete_source_connector_response import DeleteSourceConnectorResponse +from vectorize_client.models.destination_connector import DestinationConnector +from vectorize_client.models.destination_connector_schema import DestinationConnectorSchema +from vectorize_client.models.destination_connector_type import DestinationConnectorType +from vectorize_client.models.document import Document +from vectorize_client.models.extraction_chunking_strategy import ExtractionChunkingStrategy +from vectorize_client.models.extraction_result import ExtractionResult +from vectorize_client.models.extraction_result_response import ExtractionResultResponse +from vectorize_client.models.extraction_type import ExtractionType +from vectorize_client.models.get_deep_research_response import GetDeepResearchResponse +from vectorize_client.models.get_pipeline_events_response import GetPipelineEventsResponse +from vectorize_client.models.get_pipeline_metrics_response import GetPipelineMetricsResponse +from vectorize_client.models.get_pipeline_response import GetPipelineResponse +from vectorize_client.models.get_pipelines400_response import GetPipelines400Response +from vectorize_client.models.get_pipelines_response import GetPipelinesResponse +from vectorize_client.models.get_upload_files_response import GetUploadFilesResponse +from vectorize_client.models.metadata_extraction_strategy import MetadataExtractionStrategy +from vectorize_client.models.metadata_extraction_strategy_schema import MetadataExtractionStrategySchema +from vectorize_client.models.n8_n_config import N8NConfig +from vectorize_client.models.pipeline_configuration_schema import PipelineConfigurationSchema +from vectorize_client.models.pipeline_events import PipelineEvents +from vectorize_client.models.pipeline_list_summary import PipelineListSummary +from vectorize_client.models.pipeline_metrics import PipelineMetrics +from vectorize_client.models.pipeline_summary import PipelineSummary +from vectorize_client.models.remove_user_from_source_connector_request import RemoveUserFromSourceConnectorRequest +from vectorize_client.models.remove_user_from_source_connector_response import RemoveUserFromSourceConnectorResponse +from vectorize_client.models.retrieve_context import RetrieveContext +from vectorize_client.models.retrieve_context_message import RetrieveContextMessage +from vectorize_client.models.retrieve_documents_request import RetrieveDocumentsRequest +from vectorize_client.models.retrieve_documents_response import RetrieveDocumentsResponse +from vectorize_client.models.schedule_schema import ScheduleSchema +from vectorize_client.models.schedule_schema_type import ScheduleSchemaType +from vectorize_client.models.source_connector import SourceConnector +from vectorize_client.models.source_connector_schema import SourceConnectorSchema +from vectorize_client.models.source_connector_type import SourceConnectorType +from vectorize_client.models.start_deep_research_request import StartDeepResearchRequest +from vectorize_client.models.start_deep_research_response import StartDeepResearchResponse +from vectorize_client.models.start_extraction_request import StartExtractionRequest +from vectorize_client.models.start_extraction_response import StartExtractionResponse +from vectorize_client.models.start_file_upload_request import StartFileUploadRequest +from vectorize_client.models.start_file_upload_response import StartFileUploadResponse +from vectorize_client.models.start_file_upload_to_connector_request import StartFileUploadToConnectorRequest +from vectorize_client.models.start_file_upload_to_connector_response import StartFileUploadToConnectorResponse +from vectorize_client.models.start_pipeline_response import StartPipelineResponse +from vectorize_client.models.stop_pipeline_response import StopPipelineResponse +from vectorize_client.models.update_ai_platform_connector_request import UpdateAIPlatformConnectorRequest +from vectorize_client.models.update_ai_platform_connector_response import UpdateAIPlatformConnectorResponse +from vectorize_client.models.update_destination_connector_request import UpdateDestinationConnectorRequest +from vectorize_client.models.update_destination_connector_response import UpdateDestinationConnectorResponse +from vectorize_client.models.update_source_connector_request import UpdateSourceConnectorRequest +from vectorize_client.models.update_source_connector_response import UpdateSourceConnectorResponse +from vectorize_client.models.update_source_connector_response_data import UpdateSourceConnectorResponseData +from vectorize_client.models.update_user_in_source_connector_request import UpdateUserInSourceConnectorRequest +from vectorize_client.models.update_user_in_source_connector_response import UpdateUserInSourceConnectorResponse +from vectorize_client.models.updated_ai_platform_connector_data import UpdatedAIPlatformConnectorData +from vectorize_client.models.updated_destination_connector_data import UpdatedDestinationConnectorData +from vectorize_client.models.upload_file import UploadFile diff --git a/vectorize_client/models/add_user_from_source_connector_response.py b/vectorize_client/models/add_user_from_source_connector_response.py new file mode 100644 index 0000000..ad136d9 --- /dev/null +++ b/vectorize_client/models/add_user_from_source_connector_response.py @@ -0,0 +1,87 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class AddUserFromSourceConnectorResponse(BaseModel): + """ + AddUserFromSourceConnectorResponse + """ # noqa: E501 + message: StrictStr + __properties: ClassVar[List[str]] = ["message"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AddUserFromSourceConnectorResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AddUserFromSourceConnectorResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "message": obj.get("message") + }) + return _obj + + diff --git a/vectorize_client/models/add_user_to_source_connector_request.py b/vectorize_client/models/add_user_to_source_connector_request.py new file mode 100644 index 0000000..ab54109 --- /dev/null +++ b/vectorize_client/models/add_user_to_source_connector_request.py @@ -0,0 +1,104 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from vectorize_client.models.add_user_to_source_connector_request_selected_files_value import AddUserToSourceConnectorRequestSelectedFilesValue +from typing import Optional, Set +from typing_extensions import Self + +class AddUserToSourceConnectorRequest(BaseModel): + """ + AddUserToSourceConnectorRequest + """ # noqa: E501 + user_id: StrictStr = Field(alias="userId") + selected_files: Dict[str, AddUserToSourceConnectorRequestSelectedFilesValue] = Field(alias="selectedFiles") + refresh_token: StrictStr = Field(alias="refreshToken") + __properties: ClassVar[List[str]] = ["userId", "selectedFiles", "refreshToken"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AddUserToSourceConnectorRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each value in selected_files (dict) + _field_dict = {} + if self.selected_files: + for _key_selected_files in self.selected_files: + if self.selected_files[_key_selected_files]: + _field_dict[_key_selected_files] = self.selected_files[_key_selected_files].to_dict() + _dict['selectedFiles'] = _field_dict + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AddUserToSourceConnectorRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "userId": obj.get("userId"), + "selectedFiles": dict( + (_k, AddUserToSourceConnectorRequestSelectedFilesValue.from_dict(_v)) + for _k, _v in obj["selectedFiles"].items() + ) + if obj.get("selectedFiles") is not None + else None, + "refreshToken": obj.get("refreshToken") + }) + return _obj + + diff --git a/vectorize_client/models/add_user_to_source_connector_request_selected_files_value.py b/vectorize_client/models/add_user_to_source_connector_request_selected_files_value.py new file mode 100644 index 0000000..c640930 --- /dev/null +++ b/vectorize_client/models/add_user_to_source_connector_request_selected_files_value.py @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class AddUserToSourceConnectorRequestSelectedFilesValue(BaseModel): + """ + AddUserToSourceConnectorRequestSelectedFilesValue + """ # noqa: E501 + name: StrictStr + mime_type: StrictStr = Field(alias="mimeType") + __properties: ClassVar[List[str]] = ["name", "mimeType"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AddUserToSourceConnectorRequestSelectedFilesValue from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AddUserToSourceConnectorRequestSelectedFilesValue from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "name": obj.get("name"), + "mimeType": obj.get("mimeType") + }) + return _obj + + diff --git a/vectorize_client/models/advanced_query.py b/vectorize_client/models/advanced_query.py new file mode 100644 index 0000000..31506d6 --- /dev/null +++ b/vectorize_client/models/advanced_query.py @@ -0,0 +1,115 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional, Union +from typing import Optional, Set +from typing_extensions import Self + +class AdvancedQuery(BaseModel): + """ + Advanced query configuration for document retrieval + """ # noqa: E501 + mode: Optional[StrictStr] = Field(default='vector', description="Query mode - text, vector, or hybrid") + text_fields: Optional[List[StrictStr]] = Field(default=None, description="Fields to search in text mode", alias="text-fields") + match_type: Optional[StrictStr] = Field(default=None, description="Text matching type", alias="match-type") + text_boost: Optional[Union[StrictFloat, StrictInt]] = Field(default=1.0, description="Boost factor for text queries", alias="text-boost") + filters: Optional[Dict[str, Any]] = Field(default=None, description="Filters to apply to the query (Elasticsearch-style filters)") + __properties: ClassVar[List[str]] = ["mode", "text-fields", "match-type", "text-boost", "filters"] + + @field_validator('mode') + def mode_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['text', 'vector', 'hybrid']): + raise ValueError("must be one of enum values ('text', 'vector', 'hybrid')") + return value + + @field_validator('match_type') + def match_type_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['match', 'match_phrase', 'multi_match']): + raise ValueError("must be one of enum values ('match', 'match_phrase', 'multi_match')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdvancedQuery from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdvancedQuery from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "mode": obj.get("mode") if obj.get("mode") is not None else 'vector', + "text-fields": obj.get("text-fields"), + "match-type": obj.get("match-type"), + "text-boost": obj.get("text-boost") if obj.get("text-boost") is not None else 1.0, + "filters": obj.get("filters") + }) + return _obj + + diff --git a/vectorize_client/models/ai_platform.py b/vectorize_client/models/ai_platform.py new file mode 100644 index 0000000..14401d9 --- /dev/null +++ b/vectorize_client/models/ai_platform.py @@ -0,0 +1,112 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class AIPlatform(BaseModel): + """ + AIPlatform + """ # noqa: E501 + id: StrictStr + type: StrictStr + name: StrictStr + config_doc: Optional[Dict[str, Any]] = Field(default=None, alias="configDoc") + created_at: Optional[StrictStr] = Field(default=None, alias="createdAt") + created_by_id: Optional[StrictStr] = Field(default=None, alias="createdById") + last_updated_by_id: Optional[StrictStr] = Field(default=None, alias="lastUpdatedById") + created_by_email: Optional[StrictStr] = Field(default=None, alias="createdByEmail") + last_updated_by_email: Optional[StrictStr] = Field(default=None, alias="lastUpdatedByEmail") + error_message: Optional[StrictStr] = Field(default=None, alias="errorMessage") + verification_status: Optional[StrictStr] = Field(default=None, alias="verificationStatus") + __properties: ClassVar[List[str]] = ["id", "type", "name", "configDoc", "createdAt", "createdById", "lastUpdatedById", "createdByEmail", "lastUpdatedByEmail", "errorMessage", "verificationStatus"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AIPlatform from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # set to None if created_at (nullable) is None + # and model_fields_set contains the field + if self.created_at is None and "created_at" in self.model_fields_set: + _dict['createdAt'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AIPlatform from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "type": obj.get("type"), + "name": obj.get("name"), + "configDoc": obj.get("configDoc"), + "createdAt": obj.get("createdAt"), + "createdById": obj.get("createdById"), + "lastUpdatedById": obj.get("lastUpdatedById"), + "createdByEmail": obj.get("createdByEmail"), + "lastUpdatedByEmail": obj.get("lastUpdatedByEmail"), + "errorMessage": obj.get("errorMessage"), + "verificationStatus": obj.get("verificationStatus") + }) + return _obj + + diff --git a/vectorize_client/models/ai_platform_config_schema.py b/vectorize_client/models/ai_platform_config_schema.py new file mode 100644 index 0000000..2ae054f --- /dev/null +++ b/vectorize_client/models/ai_platform_config_schema.py @@ -0,0 +1,128 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class AIPlatformConfigSchema(BaseModel): + """ + AIPlatformConfigSchema + """ # noqa: E501 + embedding_model: Optional[StrictStr] = Field(default=None, alias="embeddingModel") + chunking_strategy: Optional[StrictStr] = Field(default=None, alias="chunkingStrategy") + chunk_size: Optional[Annotated[int, Field(strict=True, ge=1)]] = Field(default=None, alias="chunkSize") + chunk_overlap: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, alias="chunkOverlap") + dimensions: Optional[Annotated[int, Field(strict=True, ge=1)]] = None + extraction_strategy: Optional[StrictStr] = Field(default=None, alias="extractionStrategy") + __properties: ClassVar[List[str]] = ["embeddingModel", "chunkingStrategy", "chunkSize", "chunkOverlap", "dimensions", "extractionStrategy"] + + @field_validator('embedding_model') + def embedding_model_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['VECTORIZE_OPEN_AI_TEXT_EMBEDDING_2', 'VECTORIZE_OPEN_AI_TEXT_EMBEDDING_3_LARGE', 'VECTORIZE_OPEN_AI_TEXT_EMBEDDING_3_SMALL', 'VECTORIZE_VOYAGE_AI_2', 'VECTORIZE_VOYAGE_AI_3', 'VECTORIZE_VOYAGE_AI_3_LITE', 'VECTORIZE_VOYAGE_AI_3_LARGE', 'VECTORIZE_VOYAGE_AI_FINANCE_2', 'VECTORIZE_VOYAGE_AI_MULTILINGUAL_2', 'VECTORIZE_VOYAGE_AI_LAW_2', 'VECTORIZE_VOYAGE_AI_CODE_2', 'VECTORIZE_TITAN_TEXT_EMBEDDING_2', 'VECTORIZE_TITAN_TEXT_EMBEDDING_1', 'OPEN_AI_TEXT_EMBEDDING_2', 'OPEN_AI_TEXT_EMBEDDING_3_SMALL', 'OPEN_AI_TEXT_EMBEDDING_3_LARGE', 'VOYAGE_AI_2', 'VOYAGE_AI_3', 'VOYAGE_AI_3_LITE', 'VOYAGE_AI_3_LARGE', 'VOYAGE_AI_FINANCE_2', 'VOYAGE_AI_MULTILINGUAL_2', 'VOYAGE_AI_LAW_2', 'VOYAGE_AI_CODE_2', 'TITAN_TEXT_EMBEDDING_1', 'TITAN_TEXT_EMBEDDING_2', 'VERTEX_TEXT_EMBEDDING_4', 'VERTEX_TEXT_EMBEDDING_GECKO_3', 'VERTEX_GECKO_MULTILINGUAL_1', 'VERTEX_MULTILINGUAL_EMBEDDING_2']): + raise ValueError("must be one of enum values ('VECTORIZE_OPEN_AI_TEXT_EMBEDDING_2', 'VECTORIZE_OPEN_AI_TEXT_EMBEDDING_3_LARGE', 'VECTORIZE_OPEN_AI_TEXT_EMBEDDING_3_SMALL', 'VECTORIZE_VOYAGE_AI_2', 'VECTORIZE_VOYAGE_AI_3', 'VECTORIZE_VOYAGE_AI_3_LITE', 'VECTORIZE_VOYAGE_AI_3_LARGE', 'VECTORIZE_VOYAGE_AI_FINANCE_2', 'VECTORIZE_VOYAGE_AI_MULTILINGUAL_2', 'VECTORIZE_VOYAGE_AI_LAW_2', 'VECTORIZE_VOYAGE_AI_CODE_2', 'VECTORIZE_TITAN_TEXT_EMBEDDING_2', 'VECTORIZE_TITAN_TEXT_EMBEDDING_1', 'OPEN_AI_TEXT_EMBEDDING_2', 'OPEN_AI_TEXT_EMBEDDING_3_SMALL', 'OPEN_AI_TEXT_EMBEDDING_3_LARGE', 'VOYAGE_AI_2', 'VOYAGE_AI_3', 'VOYAGE_AI_3_LITE', 'VOYAGE_AI_3_LARGE', 'VOYAGE_AI_FINANCE_2', 'VOYAGE_AI_MULTILINGUAL_2', 'VOYAGE_AI_LAW_2', 'VOYAGE_AI_CODE_2', 'TITAN_TEXT_EMBEDDING_1', 'TITAN_TEXT_EMBEDDING_2', 'VERTEX_TEXT_EMBEDDING_4', 'VERTEX_TEXT_EMBEDDING_GECKO_3', 'VERTEX_GECKO_MULTILINGUAL_1', 'VERTEX_MULTILINGUAL_EMBEDDING_2')") + return value + + @field_validator('chunking_strategy') + def chunking_strategy_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['FIXED', 'SENTENCE', 'PARAGRAPH', 'MARKDOWN']): + raise ValueError("must be one of enum values ('FIXED', 'SENTENCE', 'PARAGRAPH', 'MARKDOWN')") + return value + + @field_validator('extraction_strategy') + def extraction_strategy_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['FAST', 'IRIS', 'MIXED']): + raise ValueError("must be one of enum values ('FAST', 'IRIS', 'MIXED')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AIPlatformConfigSchema from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AIPlatformConfigSchema from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "embeddingModel": obj.get("embeddingModel"), + "chunkingStrategy": obj.get("chunkingStrategy"), + "chunkSize": obj.get("chunkSize"), + "chunkOverlap": obj.get("chunkOverlap"), + "dimensions": obj.get("dimensions"), + "extractionStrategy": obj.get("extractionStrategy") + }) + return _obj + + diff --git a/vectorize_client/models/ai_platform_schema.py b/vectorize_client/models/ai_platform_schema.py new file mode 100644 index 0000000..e998401 --- /dev/null +++ b/vectorize_client/models/ai_platform_schema.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List +from vectorize_client.models.ai_platform_config_schema import AIPlatformConfigSchema +from vectorize_client.models.ai_platform_type import AIPlatformType +from typing import Optional, Set +from typing_extensions import Self + +class AIPlatformSchema(BaseModel): + """ + AIPlatformSchema + """ # noqa: E501 + id: StrictStr + type: AIPlatformType + config: AIPlatformConfigSchema + __properties: ClassVar[List[str]] = ["id", "type", "config"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AIPlatformSchema from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of config + if self.config: + _dict['config'] = self.config.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AIPlatformSchema from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "type": obj.get("type"), + "config": AIPlatformConfigSchema.from_dict(obj["config"]) if obj.get("config") is not None else None + }) + return _obj + + diff --git a/vectorize_client/models/ai_platform_type.py b/vectorize_client/models/ai_platform_type.py new file mode 100644 index 0000000..e60cf2e --- /dev/null +++ b/vectorize_client/models/ai_platform_type.py @@ -0,0 +1,40 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +from enum import Enum +from typing_extensions import Self + + +class AIPlatformType(str, Enum): + """ + AIPlatformType + """ + + """ + allowed enum values + """ + BEDROCK = 'BEDROCK' + VERTEX = 'VERTEX' + OPENAI = 'OPENAI' + VOYAGE = 'VOYAGE' + VECTORIZE = 'VECTORIZE' + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of AIPlatformType from a JSON string""" + return cls(json.loads(json_str)) + + diff --git a/vectorize_client/models/create_ai_platform_connector.py b/vectorize_client/models/create_ai_platform_connector.py new file mode 100644 index 0000000..50093e9 --- /dev/null +++ b/vectorize_client/models/create_ai_platform_connector.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from vectorize_client.models.ai_platform_type import AIPlatformType +from typing import Optional, Set +from typing_extensions import Self + +class CreateAIPlatformConnector(BaseModel): + """ + CreateAIPlatformConnector + """ # noqa: E501 + name: StrictStr + type: AIPlatformType + config: Optional[Dict[str, Any]] = None + __properties: ClassVar[List[str]] = ["name", "type", "config"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of CreateAIPlatformConnector from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of CreateAIPlatformConnector from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "name": obj.get("name"), + "type": obj.get("type"), + "config": obj.get("config") + }) + return _obj + + diff --git a/vectorize_client/models/create_ai_platform_connector_response.py b/vectorize_client/models/create_ai_platform_connector_response.py new file mode 100644 index 0000000..a783ca8 --- /dev/null +++ b/vectorize_client/models/create_ai_platform_connector_response.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List +from vectorize_client.models.created_ai_platform_connector import CreatedAIPlatformConnector +from typing import Optional, Set +from typing_extensions import Self + +class CreateAIPlatformConnectorResponse(BaseModel): + """ + CreateAIPlatformConnectorResponse + """ # noqa: E501 + message: StrictStr + connectors: List[CreatedAIPlatformConnector] + __properties: ClassVar[List[str]] = ["message", "connectors"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of CreateAIPlatformConnectorResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in connectors (list) + _items = [] + if self.connectors: + for _item_connectors in self.connectors: + if _item_connectors: + _items.append(_item_connectors.to_dict()) + _dict['connectors'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of CreateAIPlatformConnectorResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "message": obj.get("message"), + "connectors": [CreatedAIPlatformConnector.from_dict(_item) for _item in obj["connectors"]] if obj.get("connectors") is not None else None + }) + return _obj + + diff --git a/vectorize_client/models/create_destination_connector.py b/vectorize_client/models/create_destination_connector.py new file mode 100644 index 0000000..95df400 --- /dev/null +++ b/vectorize_client/models/create_destination_connector.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from vectorize_client.models.destination_connector_type import DestinationConnectorType +from typing import Optional, Set +from typing_extensions import Self + +class CreateDestinationConnector(BaseModel): + """ + CreateDestinationConnector + """ # noqa: E501 + name: StrictStr + type: DestinationConnectorType + config: Optional[Dict[str, Any]] = None + __properties: ClassVar[List[str]] = ["name", "type", "config"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of CreateDestinationConnector from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of CreateDestinationConnector from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "name": obj.get("name"), + "type": obj.get("type"), + "config": obj.get("config") + }) + return _obj + + diff --git a/vectorize_client/models/create_destination_connector_response.py b/vectorize_client/models/create_destination_connector_response.py new file mode 100644 index 0000000..db141d1 --- /dev/null +++ b/vectorize_client/models/create_destination_connector_response.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List +from vectorize_client.models.created_destination_connector import CreatedDestinationConnector +from typing import Optional, Set +from typing_extensions import Self + +class CreateDestinationConnectorResponse(BaseModel): + """ + CreateDestinationConnectorResponse + """ # noqa: E501 + message: StrictStr + connectors: List[CreatedDestinationConnector] + __properties: ClassVar[List[str]] = ["message", "connectors"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of CreateDestinationConnectorResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in connectors (list) + _items = [] + if self.connectors: + for _item_connectors in self.connectors: + if _item_connectors: + _items.append(_item_connectors.to_dict()) + _dict['connectors'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of CreateDestinationConnectorResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "message": obj.get("message"), + "connectors": [CreatedDestinationConnector.from_dict(_item) for _item in obj["connectors"]] if obj.get("connectors") is not None else None + }) + return _obj + + diff --git a/vectorize_client/models/create_pipeline_response.py b/vectorize_client/models/create_pipeline_response.py new file mode 100644 index 0000000..addc0d2 --- /dev/null +++ b/vectorize_client/models/create_pipeline_response.py @@ -0,0 +1,93 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List +from vectorize_client.models.create_pipeline_response_data import CreatePipelineResponseData +from typing import Optional, Set +from typing_extensions import Self + +class CreatePipelineResponse(BaseModel): + """ + CreatePipelineResponse + """ # noqa: E501 + message: StrictStr + data: CreatePipelineResponseData + __properties: ClassVar[List[str]] = ["message", "data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of CreatePipelineResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of CreatePipelineResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "message": obj.get("message"), + "data": CreatePipelineResponseData.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/vectorize_client/models/create_pipeline_response_data.py b/vectorize_client/models/create_pipeline_response_data.py new file mode 100644 index 0000000..c97c4c0 --- /dev/null +++ b/vectorize_client/models/create_pipeline_response_data.py @@ -0,0 +1,87 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class CreatePipelineResponseData(BaseModel): + """ + CreatePipelineResponseData + """ # noqa: E501 + id: StrictStr + __properties: ClassVar[List[str]] = ["id"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of CreatePipelineResponseData from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of CreatePipelineResponseData from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id") + }) + return _obj + + diff --git a/vectorize_client/models/create_source_connector.py b/vectorize_client/models/create_source_connector.py new file mode 100644 index 0000000..1499d77 --- /dev/null +++ b/vectorize_client/models/create_source_connector.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from vectorize_client.models.source_connector_type import SourceConnectorType +from typing import Optional, Set +from typing_extensions import Self + +class CreateSourceConnector(BaseModel): + """ + CreateSourceConnector + """ # noqa: E501 + name: StrictStr + type: SourceConnectorType + config: Optional[Dict[str, Any]] = None + __properties: ClassVar[List[str]] = ["name", "type", "config"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of CreateSourceConnector from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of CreateSourceConnector from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "name": obj.get("name"), + "type": obj.get("type"), + "config": obj.get("config") + }) + return _obj + + diff --git a/vectorize_client/models/create_source_connector_response.py b/vectorize_client/models/create_source_connector_response.py new file mode 100644 index 0000000..48b63fc --- /dev/null +++ b/vectorize_client/models/create_source_connector_response.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List +from vectorize_client.models.created_source_connector import CreatedSourceConnector +from typing import Optional, Set +from typing_extensions import Self + +class CreateSourceConnectorResponse(BaseModel): + """ + CreateSourceConnectorResponse + """ # noqa: E501 + message: StrictStr + connectors: List[CreatedSourceConnector] + __properties: ClassVar[List[str]] = ["message", "connectors"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of CreateSourceConnectorResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in connectors (list) + _items = [] + if self.connectors: + for _item_connectors in self.connectors: + if _item_connectors: + _items.append(_item_connectors.to_dict()) + _dict['connectors'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of CreateSourceConnectorResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "message": obj.get("message"), + "connectors": [CreatedSourceConnector.from_dict(_item) for _item in obj["connectors"]] if obj.get("connectors") is not None else None + }) + return _obj + + diff --git a/vectorize_client/models/created_ai_platform_connector.py b/vectorize_client/models/created_ai_platform_connector.py new file mode 100644 index 0000000..6b57e73 --- /dev/null +++ b/vectorize_client/models/created_ai_platform_connector.py @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class CreatedAIPlatformConnector(BaseModel): + """ + CreatedAIPlatformConnector + """ # noqa: E501 + name: StrictStr + id: StrictStr + __properties: ClassVar[List[str]] = ["name", "id"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of CreatedAIPlatformConnector from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of CreatedAIPlatformConnector from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "name": obj.get("name"), + "id": obj.get("id") + }) + return _obj + + diff --git a/vectorize_client/models/created_destination_connector.py b/vectorize_client/models/created_destination_connector.py new file mode 100644 index 0000000..330dd47 --- /dev/null +++ b/vectorize_client/models/created_destination_connector.py @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class CreatedDestinationConnector(BaseModel): + """ + CreatedDestinationConnector + """ # noqa: E501 + name: StrictStr + id: StrictStr + __properties: ClassVar[List[str]] = ["name", "id"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of CreatedDestinationConnector from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of CreatedDestinationConnector from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "name": obj.get("name"), + "id": obj.get("id") + }) + return _obj + + diff --git a/vectorize_client/models/created_source_connector.py b/vectorize_client/models/created_source_connector.py new file mode 100644 index 0000000..aeb91c1 --- /dev/null +++ b/vectorize_client/models/created_source_connector.py @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class CreatedSourceConnector(BaseModel): + """ + CreatedSourceConnector + """ # noqa: E501 + name: StrictStr + id: StrictStr + __properties: ClassVar[List[str]] = ["name", "id"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of CreatedSourceConnector from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of CreatedSourceConnector from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "name": obj.get("name"), + "id": obj.get("id") + }) + return _obj + + diff --git a/vectorize_client/models/deep_research_result.py b/vectorize_client/models/deep_research_result.py new file mode 100644 index 0000000..d6c72c9 --- /dev/null +++ b/vectorize_client/models/deep_research_result.py @@ -0,0 +1,93 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DeepResearchResult(BaseModel): + """ + DeepResearchResult + """ # noqa: E501 + success: StrictBool + events: Optional[List[StrictStr]] = None + markdown: Optional[StrictStr] = None + error: Optional[StrictStr] = None + __properties: ClassVar[List[str]] = ["success", "events", "markdown", "error"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeepResearchResult from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeepResearchResult from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "success": obj.get("success"), + "events": obj.get("events"), + "markdown": obj.get("markdown"), + "error": obj.get("error") + }) + return _obj + + diff --git a/vectorize_client/models/delete_ai_platform_connector_response.py b/vectorize_client/models/delete_ai_platform_connector_response.py new file mode 100644 index 0000000..e07840a --- /dev/null +++ b/vectorize_client/models/delete_ai_platform_connector_response.py @@ -0,0 +1,87 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class DeleteAIPlatformConnectorResponse(BaseModel): + """ + DeleteAIPlatformConnectorResponse + """ # noqa: E501 + message: StrictStr + __properties: ClassVar[List[str]] = ["message"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeleteAIPlatformConnectorResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeleteAIPlatformConnectorResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "message": obj.get("message") + }) + return _obj + + diff --git a/vectorize_client/models/delete_destination_connector_response.py b/vectorize_client/models/delete_destination_connector_response.py new file mode 100644 index 0000000..b6b4a08 --- /dev/null +++ b/vectorize_client/models/delete_destination_connector_response.py @@ -0,0 +1,87 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class DeleteDestinationConnectorResponse(BaseModel): + """ + DeleteDestinationConnectorResponse + """ # noqa: E501 + message: StrictStr + __properties: ClassVar[List[str]] = ["message"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeleteDestinationConnectorResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeleteDestinationConnectorResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "message": obj.get("message") + }) + return _obj + + diff --git a/vectorize_client/models/delete_file_response.py b/vectorize_client/models/delete_file_response.py new file mode 100644 index 0000000..45749a6 --- /dev/null +++ b/vectorize_client/models/delete_file_response.py @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class DeleteFileResponse(BaseModel): + """ + DeleteFileResponse + """ # noqa: E501 + message: StrictStr + file_name: StrictStr = Field(alias="fileName") + __properties: ClassVar[List[str]] = ["message", "fileName"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeleteFileResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeleteFileResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "message": obj.get("message"), + "fileName": obj.get("fileName") + }) + return _obj + + diff --git a/vectorize_client/models/delete_pipeline_response.py b/vectorize_client/models/delete_pipeline_response.py new file mode 100644 index 0000000..b05f005 --- /dev/null +++ b/vectorize_client/models/delete_pipeline_response.py @@ -0,0 +1,87 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class DeletePipelineResponse(BaseModel): + """ + DeletePipelineResponse + """ # noqa: E501 + message: StrictStr + __properties: ClassVar[List[str]] = ["message"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeletePipelineResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeletePipelineResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "message": obj.get("message") + }) + return _obj + + diff --git a/vectorize_client/models/delete_source_connector_response.py b/vectorize_client/models/delete_source_connector_response.py new file mode 100644 index 0000000..1be364e --- /dev/null +++ b/vectorize_client/models/delete_source_connector_response.py @@ -0,0 +1,87 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class DeleteSourceConnectorResponse(BaseModel): + """ + DeleteSourceConnectorResponse + """ # noqa: E501 + message: StrictStr + __properties: ClassVar[List[str]] = ["message"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DeleteSourceConnectorResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DeleteSourceConnectorResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "message": obj.get("message") + }) + return _obj + + diff --git a/vectorize_client/models/destination_connector.py b/vectorize_client/models/destination_connector.py new file mode 100644 index 0000000..4351bf8 --- /dev/null +++ b/vectorize_client/models/destination_connector.py @@ -0,0 +1,112 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DestinationConnector(BaseModel): + """ + DestinationConnector + """ # noqa: E501 + id: StrictStr + type: StrictStr + name: StrictStr + config_doc: Optional[Dict[str, Any]] = Field(default=None, alias="configDoc") + created_at: Optional[StrictStr] = Field(default=None, alias="createdAt") + created_by_id: Optional[StrictStr] = Field(default=None, alias="createdById") + last_updated_by_id: Optional[StrictStr] = Field(default=None, alias="lastUpdatedById") + created_by_email: Optional[StrictStr] = Field(default=None, alias="createdByEmail") + last_updated_by_email: Optional[StrictStr] = Field(default=None, alias="lastUpdatedByEmail") + error_message: Optional[StrictStr] = Field(default=None, alias="errorMessage") + verification_status: Optional[StrictStr] = Field(default=None, alias="verificationStatus") + __properties: ClassVar[List[str]] = ["id", "type", "name", "configDoc", "createdAt", "createdById", "lastUpdatedById", "createdByEmail", "lastUpdatedByEmail", "errorMessage", "verificationStatus"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DestinationConnector from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # set to None if created_at (nullable) is None + # and model_fields_set contains the field + if self.created_at is None and "created_at" in self.model_fields_set: + _dict['createdAt'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DestinationConnector from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "type": obj.get("type"), + "name": obj.get("name"), + "configDoc": obj.get("configDoc"), + "createdAt": obj.get("createdAt"), + "createdById": obj.get("createdById"), + "lastUpdatedById": obj.get("lastUpdatedById"), + "createdByEmail": obj.get("createdByEmail"), + "lastUpdatedByEmail": obj.get("lastUpdatedByEmail"), + "errorMessage": obj.get("errorMessage"), + "verificationStatus": obj.get("verificationStatus") + }) + return _obj + + diff --git a/vectorize_client/models/destination_connector_schema.py b/vectorize_client/models/destination_connector_schema.py new file mode 100644 index 0000000..8206eeb --- /dev/null +++ b/vectorize_client/models/destination_connector_schema.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from vectorize_client.models.destination_connector_type import DestinationConnectorType +from typing import Optional, Set +from typing_extensions import Self + +class DestinationConnectorSchema(BaseModel): + """ + DestinationConnectorSchema + """ # noqa: E501 + id: StrictStr + type: DestinationConnectorType + config: Optional[Dict[str, Any]] = None + __properties: ClassVar[List[str]] = ["id", "type", "config"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DestinationConnectorSchema from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DestinationConnectorSchema from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "type": obj.get("type"), + "config": obj.get("config") + }) + return _obj + + diff --git a/vectorize_client/models/destination_connector_type.py b/vectorize_client/models/destination_connector_type.py new file mode 100644 index 0000000..ca06824 --- /dev/null +++ b/vectorize_client/models/destination_connector_type.py @@ -0,0 +1,49 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +from enum import Enum +from typing_extensions import Self + + +class DestinationConnectorType(str, Enum): + """ + DestinationConnectorType + """ + + """ + allowed enum values + """ + CAPELLA = 'CAPELLA' + DATASTAX = 'DATASTAX' + ELASTIC = 'ELASTIC' + PINECONE = 'PINECONE' + SINGLESTORE = 'SINGLESTORE' + MILVUS = 'MILVUS' + POSTGRESQL = 'POSTGRESQL' + QDRANT = 'QDRANT' + SUPABASE = 'SUPABASE' + WEAVIATE = 'WEAVIATE' + AZUREAISEARCH = 'AZUREAISEARCH' + VECTORIZE = 'VECTORIZE' + CHROMA = 'CHROMA' + MONGODB = 'MONGODB' + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of DestinationConnectorType from a JSON string""" + return cls(json.loads(json_str)) + + diff --git a/vectorize_client/models/document.py b/vectorize_client/models/document.py new file mode 100644 index 0000000..199ba87 --- /dev/null +++ b/vectorize_client/models/document.py @@ -0,0 +1,124 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictFloat, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional, Union +from typing import Optional, Set +from typing_extensions import Self + +class Document(BaseModel): + """ + Document + """ # noqa: E501 + relevancy: Union[StrictFloat, StrictInt] + id: StrictStr + text: StrictStr + chunk_id: StrictStr + total_chunks: StrictStr + origin: StrictStr + origin_id: StrictStr + similarity: Union[StrictFloat, StrictInt] + source: StrictStr + unique_source: StrictStr + source_display_name: StrictStr + pipeline_id: Optional[StrictStr] = None + org_id: Optional[StrictStr] = None + additional_properties: Dict[str, Any] = {} + __properties: ClassVar[List[str]] = ["relevancy", "id", "text", "chunk_id", "total_chunks", "origin", "origin_id", "similarity", "source", "unique_source", "source_display_name", "pipeline_id", "org_id"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of Document from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * Fields in `self.additional_properties` are added to the output dict. + """ + excluded_fields: Set[str] = set([ + "additional_properties", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # puts key-value pairs in additional_properties in the top level + if self.additional_properties is not None: + for _key, _value in self.additional_properties.items(): + _dict[_key] = _value + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of Document from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "relevancy": obj.get("relevancy"), + "id": obj.get("id"), + "text": obj.get("text"), + "chunk_id": obj.get("chunk_id"), + "total_chunks": obj.get("total_chunks"), + "origin": obj.get("origin"), + "origin_id": obj.get("origin_id"), + "similarity": obj.get("similarity"), + "source": obj.get("source"), + "unique_source": obj.get("unique_source"), + "source_display_name": obj.get("source_display_name"), + "pipeline_id": obj.get("pipeline_id"), + "org_id": obj.get("org_id") + }) + # store additional fields in additional_properties + for _key in obj.keys(): + if _key not in cls.__properties: + _obj.additional_properties[_key] = obj.get(_key) + + return _obj + + diff --git a/vectorize_client/models/extraction_chunking_strategy.py b/vectorize_client/models/extraction_chunking_strategy.py new file mode 100644 index 0000000..0c0fc33 --- /dev/null +++ b/vectorize_client/models/extraction_chunking_strategy.py @@ -0,0 +1,36 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +from enum import Enum +from typing_extensions import Self + + +class ExtractionChunkingStrategy(str, Enum): + """ + ExtractionChunkingStrategy + """ + + """ + allowed enum values + """ + MARKDOWN = 'markdown' + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of ExtractionChunkingStrategy from a JSON string""" + return cls(json.loads(json_str)) + + diff --git a/vectorize_client/models/extraction_result.py b/vectorize_client/models/extraction_result.py new file mode 100644 index 0000000..01d5491 --- /dev/null +++ b/vectorize_client/models/extraction_result.py @@ -0,0 +1,101 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ExtractionResult(BaseModel): + """ + ExtractionResult + """ # noqa: E501 + success: StrictBool + chunks: Optional[List[StrictStr]] = None + text: Optional[StrictStr] = None + metadata: Optional[StrictStr] = None + metadata_schema: Optional[StrictStr] = Field(default=None, alias="metadataSchema") + chunks_metadata: Optional[List[StrictStr]] = Field(default=None, alias="chunksMetadata") + chunks_schema: Optional[List[StrictStr]] = Field(default=None, alias="chunksSchema") + error: Optional[StrictStr] = None + __properties: ClassVar[List[str]] = ["success", "chunks", "text", "metadata", "metadataSchema", "chunksMetadata", "chunksSchema", "error"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ExtractionResult from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ExtractionResult from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "success": obj.get("success"), + "chunks": obj.get("chunks"), + "text": obj.get("text"), + "metadata": obj.get("metadata"), + "metadataSchema": obj.get("metadataSchema"), + "chunksMetadata": obj.get("chunksMetadata"), + "chunksSchema": obj.get("chunksSchema"), + "error": obj.get("error") + }) + return _obj + + diff --git a/vectorize_client/models/extraction_result_response.py b/vectorize_client/models/extraction_result_response.py new file mode 100644 index 0000000..57968d4 --- /dev/null +++ b/vectorize_client/models/extraction_result_response.py @@ -0,0 +1,93 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictBool +from typing import Any, ClassVar, Dict, List, Optional +from vectorize_client.models.extraction_result import ExtractionResult +from typing import Optional, Set +from typing_extensions import Self + +class ExtractionResultResponse(BaseModel): + """ + ExtractionResultResponse + """ # noqa: E501 + ready: StrictBool + data: Optional[ExtractionResult] = None + __properties: ClassVar[List[str]] = ["ready", "data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ExtractionResultResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ExtractionResultResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "ready": obj.get("ready"), + "data": ExtractionResult.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/vectorize_client/models/extraction_type.py b/vectorize_client/models/extraction_type.py new file mode 100644 index 0000000..c457543 --- /dev/null +++ b/vectorize_client/models/extraction_type.py @@ -0,0 +1,36 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +from enum import Enum +from typing_extensions import Self + + +class ExtractionType(str, Enum): + """ + ExtractionType + """ + + """ + allowed enum values + """ + IRIS = 'iris' + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of ExtractionType from a JSON string""" + return cls(json.loads(json_str)) + + diff --git a/vectorize_client/models/get_deep_research_response.py b/vectorize_client/models/get_deep_research_response.py new file mode 100644 index 0000000..05d6bad --- /dev/null +++ b/vectorize_client/models/get_deep_research_response.py @@ -0,0 +1,93 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictBool +from typing import Any, ClassVar, Dict, List, Optional +from vectorize_client.models.deep_research_result import DeepResearchResult +from typing import Optional, Set +from typing_extensions import Self + +class GetDeepResearchResponse(BaseModel): + """ + GetDeepResearchResponse + """ # noqa: E501 + ready: StrictBool + data: Optional[DeepResearchResult] = None + __properties: ClassVar[List[str]] = ["ready", "data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of GetDeepResearchResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of GetDeepResearchResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "ready": obj.get("ready"), + "data": DeepResearchResult.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/vectorize_client/models/get_pipeline_events_response.py b/vectorize_client/models/get_pipeline_events_response.py new file mode 100644 index 0000000..b70fce4 --- /dev/null +++ b/vectorize_client/models/get_pipeline_events_response.py @@ -0,0 +1,99 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from vectorize_client.models.pipeline_events import PipelineEvents +from typing import Optional, Set +from typing_extensions import Self + +class GetPipelineEventsResponse(BaseModel): + """ + GetPipelineEventsResponse + """ # noqa: E501 + message: StrictStr + next_token: Optional[StrictStr] = Field(default=None, alias="nextToken") + data: List[PipelineEvents] + __properties: ClassVar[List[str]] = ["message", "nextToken", "data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of GetPipelineEventsResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data (list) + _items = [] + if self.data: + for _item_data in self.data: + if _item_data: + _items.append(_item_data.to_dict()) + _dict['data'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of GetPipelineEventsResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "message": obj.get("message"), + "nextToken": obj.get("nextToken"), + "data": [PipelineEvents.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None + }) + return _obj + + diff --git a/vectorize_client/models/get_pipeline_metrics_response.py b/vectorize_client/models/get_pipeline_metrics_response.py new file mode 100644 index 0000000..6545e1f --- /dev/null +++ b/vectorize_client/models/get_pipeline_metrics_response.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List +from vectorize_client.models.pipeline_metrics import PipelineMetrics +from typing import Optional, Set +from typing_extensions import Self + +class GetPipelineMetricsResponse(BaseModel): + """ + GetPipelineMetricsResponse + """ # noqa: E501 + message: StrictStr + data: List[PipelineMetrics] + __properties: ClassVar[List[str]] = ["message", "data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of GetPipelineMetricsResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data (list) + _items = [] + if self.data: + for _item_data in self.data: + if _item_data: + _items.append(_item_data.to_dict()) + _dict['data'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of GetPipelineMetricsResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "message": obj.get("message"), + "data": [PipelineMetrics.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None + }) + return _obj + + diff --git a/vectorize_client/models/get_pipeline_response.py b/vectorize_client/models/get_pipeline_response.py new file mode 100644 index 0000000..6f63df6 --- /dev/null +++ b/vectorize_client/models/get_pipeline_response.py @@ -0,0 +1,93 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List +from vectorize_client.models.pipeline_summary import PipelineSummary +from typing import Optional, Set +from typing_extensions import Self + +class GetPipelineResponse(BaseModel): + """ + GetPipelineResponse + """ # noqa: E501 + message: StrictStr + data: PipelineSummary + __properties: ClassVar[List[str]] = ["message", "data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of GetPipelineResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of GetPipelineResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "message": obj.get("message"), + "data": PipelineSummary.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/vectorize_client/models/get_pipelines400_response.py b/vectorize_client/models/get_pipelines400_response.py new file mode 100644 index 0000000..ab3e477 --- /dev/null +++ b/vectorize_client/models/get_pipelines400_response.py @@ -0,0 +1,93 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class GetPipelines400Response(BaseModel): + """ + GetPipelines400Response + """ # noqa: E501 + error: StrictStr + details: Optional[StrictStr] = None + failed_updates: Optional[List[StrictStr]] = Field(default=None, alias="failedUpdates") + successful_updates: Optional[List[StrictStr]] = Field(default=None, alias="successfulUpdates") + __properties: ClassVar[List[str]] = ["error", "details", "failedUpdates", "successfulUpdates"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of GetPipelines400Response from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of GetPipelines400Response from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "error": obj.get("error"), + "details": obj.get("details"), + "failedUpdates": obj.get("failedUpdates"), + "successfulUpdates": obj.get("successfulUpdates") + }) + return _obj + + diff --git a/vectorize_client/models/get_pipelines_response.py b/vectorize_client/models/get_pipelines_response.py new file mode 100644 index 0000000..974f2c5 --- /dev/null +++ b/vectorize_client/models/get_pipelines_response.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List +from vectorize_client.models.pipeline_list_summary import PipelineListSummary +from typing import Optional, Set +from typing_extensions import Self + +class GetPipelinesResponse(BaseModel): + """ + GetPipelinesResponse + """ # noqa: E501 + message: StrictStr + data: List[PipelineListSummary] + __properties: ClassVar[List[str]] = ["message", "data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of GetPipelinesResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data (list) + _items = [] + if self.data: + for _item_data in self.data: + if _item_data: + _items.append(_item_data.to_dict()) + _dict['data'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of GetPipelinesResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "message": obj.get("message"), + "data": [PipelineListSummary.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None + }) + return _obj + + diff --git a/vectorize_client/models/get_upload_files_response.py b/vectorize_client/models/get_upload_files_response.py new file mode 100644 index 0000000..060208a --- /dev/null +++ b/vectorize_client/models/get_upload_files_response.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List +from vectorize_client.models.upload_file import UploadFile +from typing import Optional, Set +from typing_extensions import Self + +class GetUploadFilesResponse(BaseModel): + """ + GetUploadFilesResponse + """ # noqa: E501 + message: StrictStr + files: List[UploadFile] + __properties: ClassVar[List[str]] = ["message", "files"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of GetUploadFilesResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in files (list) + _items = [] + if self.files: + for _item_files in self.files: + if _item_files: + _items.append(_item_files.to_dict()) + _dict['files'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of GetUploadFilesResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "message": obj.get("message"), + "files": [UploadFile.from_dict(_item) for _item in obj["files"]] if obj.get("files") is not None else None + }) + return _obj + + diff --git a/vectorize_client/models/metadata_extraction_strategy.py b/vectorize_client/models/metadata_extraction_strategy.py new file mode 100644 index 0000000..5e23db1 --- /dev/null +++ b/vectorize_client/models/metadata_extraction_strategy.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool +from typing import Any, ClassVar, Dict, List, Optional +from vectorize_client.models.metadata_extraction_strategy_schema import MetadataExtractionStrategySchema +from typing import Optional, Set +from typing_extensions import Self + +class MetadataExtractionStrategy(BaseModel): + """ + MetadataExtractionStrategy + """ # noqa: E501 + schemas: Optional[List[MetadataExtractionStrategySchema]] = None + infer_schema: Optional[StrictBool] = Field(default=None, alias="inferSchema") + __properties: ClassVar[List[str]] = ["schemas", "inferSchema"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of MetadataExtractionStrategy from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in schemas (list) + _items = [] + if self.schemas: + for _item_schemas in self.schemas: + if _item_schemas: + _items.append(_item_schemas.to_dict()) + _dict['schemas'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of MetadataExtractionStrategy from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "schemas": [MetadataExtractionStrategySchema.from_dict(_item) for _item in obj["schemas"]] if obj.get("schemas") is not None else None, + "inferSchema": obj.get("inferSchema") + }) + return _obj + + diff --git a/vectorize_client/models/metadata_extraction_strategy_schema.py b/vectorize_client/models/metadata_extraction_strategy_schema.py new file mode 100644 index 0000000..4178318 --- /dev/null +++ b/vectorize_client/models/metadata_extraction_strategy_schema.py @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class MetadataExtractionStrategySchema(BaseModel): + """ + MetadataExtractionStrategySchema + """ # noqa: E501 + id: StrictStr + var_schema: StrictStr = Field(alias="schema") + __properties: ClassVar[List[str]] = ["id", "schema"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of MetadataExtractionStrategySchema from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of MetadataExtractionStrategySchema from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "schema": obj.get("schema") + }) + return _obj + + diff --git a/vectorize_client/models/n8_n_config.py b/vectorize_client/models/n8_n_config.py new file mode 100644 index 0000000..5a1e4f1 --- /dev/null +++ b/vectorize_client/models/n8_n_config.py @@ -0,0 +1,91 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class N8NConfig(BaseModel): + """ + N8NConfig + """ # noqa: E501 + account: StrictStr + webhook_path: StrictStr = Field(alias="webhookPath") + headers: Optional[Dict[str, StrictStr]] = None + __properties: ClassVar[List[str]] = ["account", "webhookPath", "headers"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of N8NConfig from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of N8NConfig from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "account": obj.get("account"), + "webhookPath": obj.get("webhookPath"), + "headers": obj.get("headers") + }) + return _obj + + diff --git a/vectorize_client/models/pipeline_configuration_schema.py b/vectorize_client/models/pipeline_configuration_schema.py new file mode 100644 index 0000000..977c150 --- /dev/null +++ b/vectorize_client/models/pipeline_configuration_schema.py @@ -0,0 +1,116 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from vectorize_client.models.ai_platform_schema import AIPlatformSchema +from vectorize_client.models.destination_connector_schema import DestinationConnectorSchema +from vectorize_client.models.schedule_schema import ScheduleSchema +from vectorize_client.models.source_connector_schema import SourceConnectorSchema +from typing import Optional, Set +from typing_extensions import Self + +class PipelineConfigurationSchema(BaseModel): + """ + PipelineConfigurationSchema + """ # noqa: E501 + source_connectors: Annotated[List[SourceConnectorSchema], Field(min_length=1)] = Field(alias="sourceConnectors") + destination_connector: DestinationConnectorSchema = Field(alias="destinationConnector") + ai_platform: AIPlatformSchema = Field(alias="aiPlatform") + pipeline_name: Annotated[str, Field(min_length=1, strict=True)] = Field(alias="pipelineName") + schedule: ScheduleSchema + __properties: ClassVar[List[str]] = ["sourceConnectors", "destinationConnector", "aiPlatform", "pipelineName", "schedule"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of PipelineConfigurationSchema from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in source_connectors (list) + _items = [] + if self.source_connectors: + for _item_source_connectors in self.source_connectors: + if _item_source_connectors: + _items.append(_item_source_connectors.to_dict()) + _dict['sourceConnectors'] = _items + # override the default output from pydantic by calling `to_dict()` of destination_connector + if self.destination_connector: + _dict['destinationConnector'] = self.destination_connector.to_dict() + # override the default output from pydantic by calling `to_dict()` of ai_platform + if self.ai_platform: + _dict['aiPlatform'] = self.ai_platform.to_dict() + # override the default output from pydantic by calling `to_dict()` of schedule + if self.schedule: + _dict['schedule'] = self.schedule.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of PipelineConfigurationSchema from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "sourceConnectors": [SourceConnectorSchema.from_dict(_item) for _item in obj["sourceConnectors"]] if obj.get("sourceConnectors") is not None else None, + "destinationConnector": DestinationConnectorSchema.from_dict(obj["destinationConnector"]) if obj.get("destinationConnector") is not None else None, + "aiPlatform": AIPlatformSchema.from_dict(obj["aiPlatform"]) if obj.get("aiPlatform") is not None else None, + "pipelineName": obj.get("pipelineName"), + "schedule": ScheduleSchema.from_dict(obj["schedule"]) if obj.get("schedule") is not None else None + }) + return _obj + + diff --git a/vectorize_client/models/pipeline_events.py b/vectorize_client/models/pipeline_events.py new file mode 100644 index 0000000..7d9971a --- /dev/null +++ b/vectorize_client/models/pipeline_events.py @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class PipelineEvents(BaseModel): + """ + PipelineEvents + """ # noqa: E501 + id: StrictStr + type: StrictStr + timestamp: Optional[StrictStr] + details: Optional[Dict[str, Any]] = None + summary: Optional[Dict[str, Any]] = None + __properties: ClassVar[List[str]] = ["id", "type", "timestamp", "details", "summary"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of PipelineEvents from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # set to None if timestamp (nullable) is None + # and model_fields_set contains the field + if self.timestamp is None and "timestamp" in self.model_fields_set: + _dict['timestamp'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of PipelineEvents from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "type": obj.get("type"), + "timestamp": obj.get("timestamp"), + "details": obj.get("details"), + "summary": obj.get("summary") + }) + return _obj + + diff --git a/vectorize_client/models/pipeline_list_summary.py b/vectorize_client/models/pipeline_list_summary.py new file mode 100644 index 0000000..8540ba7 --- /dev/null +++ b/vectorize_client/models/pipeline_list_summary.py @@ -0,0 +1,116 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional, Union +from typing import Optional, Set +from typing_extensions import Self + +class PipelineListSummary(BaseModel): + """ + PipelineListSummary + """ # noqa: E501 + id: StrictStr + name: StrictStr + document_count: Union[StrictFloat, StrictInt] = Field(alias="documentCount") + source_connector_auth_ids: List[StrictStr] = Field(alias="sourceConnectorAuthIds") + destination_connector_auth_ids: List[StrictStr] = Field(alias="destinationConnectorAuthIds") + ai_platform_auth_ids: List[StrictStr] = Field(alias="aiPlatformAuthIds") + source_connector_types: List[StrictStr] = Field(alias="sourceConnectorTypes") + destination_connector_types: List[StrictStr] = Field(alias="destinationConnectorTypes") + ai_platform_types: List[StrictStr] = Field(alias="aiPlatformTypes") + created_at: Optional[StrictStr] = Field(alias="createdAt") + created_by: StrictStr = Field(alias="createdBy") + status: Optional[StrictStr] = None + config_doc: Optional[Dict[str, Any]] = Field(default=None, alias="configDoc") + __properties: ClassVar[List[str]] = ["id", "name", "documentCount", "sourceConnectorAuthIds", "destinationConnectorAuthIds", "aiPlatformAuthIds", "sourceConnectorTypes", "destinationConnectorTypes", "aiPlatformTypes", "createdAt", "createdBy", "status", "configDoc"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of PipelineListSummary from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # set to None if created_at (nullable) is None + # and model_fields_set contains the field + if self.created_at is None and "created_at" in self.model_fields_set: + _dict['createdAt'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of PipelineListSummary from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "name": obj.get("name"), + "documentCount": obj.get("documentCount"), + "sourceConnectorAuthIds": obj.get("sourceConnectorAuthIds"), + "destinationConnectorAuthIds": obj.get("destinationConnectorAuthIds"), + "aiPlatformAuthIds": obj.get("aiPlatformAuthIds"), + "sourceConnectorTypes": obj.get("sourceConnectorTypes"), + "destinationConnectorTypes": obj.get("destinationConnectorTypes"), + "aiPlatformTypes": obj.get("aiPlatformTypes"), + "createdAt": obj.get("createdAt"), + "createdBy": obj.get("createdBy"), + "status": obj.get("status"), + "configDoc": obj.get("configDoc") + }) + return _obj + + diff --git a/vectorize_client/models/pipeline_metrics.py b/vectorize_client/models/pipeline_metrics.py new file mode 100644 index 0000000..13ad162 --- /dev/null +++ b/vectorize_client/models/pipeline_metrics.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional, Union +from typing import Optional, Set +from typing_extensions import Self + +class PipelineMetrics(BaseModel): + """ + PipelineMetrics + """ # noqa: E501 + timestamp: Optional[StrictStr] + new_objects: Union[StrictFloat, StrictInt] = Field(alias="newObjects") + changed_objects: Union[StrictFloat, StrictInt] = Field(alias="changedObjects") + deleted_objects: Union[StrictFloat, StrictInt] = Field(alias="deletedObjects") + __properties: ClassVar[List[str]] = ["timestamp", "newObjects", "changedObjects", "deletedObjects"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of PipelineMetrics from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # set to None if timestamp (nullable) is None + # and model_fields_set contains the field + if self.timestamp is None and "timestamp" in self.model_fields_set: + _dict['timestamp'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of PipelineMetrics from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "timestamp": obj.get("timestamp"), + "newObjects": obj.get("newObjects"), + "changedObjects": obj.get("changedObjects"), + "deletedObjects": obj.get("deletedObjects") + }) + return _obj + + diff --git a/vectorize_client/models/pipeline_summary.py b/vectorize_client/models/pipeline_summary.py new file mode 100644 index 0000000..7ac5218 --- /dev/null +++ b/vectorize_client/models/pipeline_summary.py @@ -0,0 +1,146 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional, Union +from vectorize_client.models.ai_platform import AIPlatform +from vectorize_client.models.destination_connector import DestinationConnector +from vectorize_client.models.source_connector import SourceConnector +from typing import Optional, Set +from typing_extensions import Self + +class PipelineSummary(BaseModel): + """ + PipelineSummary + """ # noqa: E501 + id: StrictStr + name: StrictStr + document_count: Union[StrictFloat, StrictInt] = Field(alias="documentCount") + source_connector_auth_ids: List[StrictStr] = Field(alias="sourceConnectorAuthIds") + destination_connector_auth_ids: List[StrictStr] = Field(alias="destinationConnectorAuthIds") + ai_platform_auth_ids: List[StrictStr] = Field(alias="aiPlatformAuthIds") + source_connector_types: List[StrictStr] = Field(alias="sourceConnectorTypes") + destination_connector_types: List[StrictStr] = Field(alias="destinationConnectorTypes") + ai_platform_types: List[StrictStr] = Field(alias="aiPlatformTypes") + created_at: Optional[StrictStr] = Field(alias="createdAt") + created_by: StrictStr = Field(alias="createdBy") + status: Optional[StrictStr] = None + config_doc: Optional[Dict[str, Any]] = Field(default=None, alias="configDoc") + source_connectors: List[SourceConnector] = Field(alias="sourceConnectors") + destination_connectors: List[DestinationConnector] = Field(alias="destinationConnectors") + ai_platforms: List[AIPlatform] = Field(alias="aiPlatforms") + __properties: ClassVar[List[str]] = ["id", "name", "documentCount", "sourceConnectorAuthIds", "destinationConnectorAuthIds", "aiPlatformAuthIds", "sourceConnectorTypes", "destinationConnectorTypes", "aiPlatformTypes", "createdAt", "createdBy", "status", "configDoc", "sourceConnectors", "destinationConnectors", "aiPlatforms"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of PipelineSummary from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in source_connectors (list) + _items = [] + if self.source_connectors: + for _item_source_connectors in self.source_connectors: + if _item_source_connectors: + _items.append(_item_source_connectors.to_dict()) + _dict['sourceConnectors'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in destination_connectors (list) + _items = [] + if self.destination_connectors: + for _item_destination_connectors in self.destination_connectors: + if _item_destination_connectors: + _items.append(_item_destination_connectors.to_dict()) + _dict['destinationConnectors'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in ai_platforms (list) + _items = [] + if self.ai_platforms: + for _item_ai_platforms in self.ai_platforms: + if _item_ai_platforms: + _items.append(_item_ai_platforms.to_dict()) + _dict['aiPlatforms'] = _items + # set to None if created_at (nullable) is None + # and model_fields_set contains the field + if self.created_at is None and "created_at" in self.model_fields_set: + _dict['createdAt'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of PipelineSummary from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "name": obj.get("name"), + "documentCount": obj.get("documentCount"), + "sourceConnectorAuthIds": obj.get("sourceConnectorAuthIds"), + "destinationConnectorAuthIds": obj.get("destinationConnectorAuthIds"), + "aiPlatformAuthIds": obj.get("aiPlatformAuthIds"), + "sourceConnectorTypes": obj.get("sourceConnectorTypes"), + "destinationConnectorTypes": obj.get("destinationConnectorTypes"), + "aiPlatformTypes": obj.get("aiPlatformTypes"), + "createdAt": obj.get("createdAt"), + "createdBy": obj.get("createdBy"), + "status": obj.get("status"), + "configDoc": obj.get("configDoc"), + "sourceConnectors": [SourceConnector.from_dict(_item) for _item in obj["sourceConnectors"]] if obj.get("sourceConnectors") is not None else None, + "destinationConnectors": [DestinationConnector.from_dict(_item) for _item in obj["destinationConnectors"]] if obj.get("destinationConnectors") is not None else None, + "aiPlatforms": [AIPlatform.from_dict(_item) for _item in obj["aiPlatforms"]] if obj.get("aiPlatforms") is not None else None + }) + return _obj + + diff --git a/vectorize_client/models/remove_user_from_source_connector_request.py b/vectorize_client/models/remove_user_from_source_connector_request.py new file mode 100644 index 0000000..045d7cb --- /dev/null +++ b/vectorize_client/models/remove_user_from_source_connector_request.py @@ -0,0 +1,87 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class RemoveUserFromSourceConnectorRequest(BaseModel): + """ + RemoveUserFromSourceConnectorRequest + """ # noqa: E501 + user_id: StrictStr = Field(alias="userId") + __properties: ClassVar[List[str]] = ["userId"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of RemoveUserFromSourceConnectorRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of RemoveUserFromSourceConnectorRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "userId": obj.get("userId") + }) + return _obj + + diff --git a/vectorize_client/models/remove_user_from_source_connector_response.py b/vectorize_client/models/remove_user_from_source_connector_response.py new file mode 100644 index 0000000..cb164a8 --- /dev/null +++ b/vectorize_client/models/remove_user_from_source_connector_response.py @@ -0,0 +1,87 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class RemoveUserFromSourceConnectorResponse(BaseModel): + """ + RemoveUserFromSourceConnectorResponse + """ # noqa: E501 + message: StrictStr + __properties: ClassVar[List[str]] = ["message"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of RemoveUserFromSourceConnectorResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of RemoveUserFromSourceConnectorResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "message": obj.get("message") + }) + return _obj + + diff --git a/vectorize_client/models/retrieve_context.py b/vectorize_client/models/retrieve_context.py new file mode 100644 index 0000000..0cc45c8 --- /dev/null +++ b/vectorize_client/models/retrieve_context.py @@ -0,0 +1,95 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from vectorize_client.models.retrieve_context_message import RetrieveContextMessage +from typing import Optional, Set +from typing_extensions import Self + +class RetrieveContext(BaseModel): + """ + RetrieveContext + """ # noqa: E501 + messages: List[RetrieveContextMessage] + __properties: ClassVar[List[str]] = ["messages"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of RetrieveContext from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in messages (list) + _items = [] + if self.messages: + for _item_messages in self.messages: + if _item_messages: + _items.append(_item_messages.to_dict()) + _dict['messages'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of RetrieveContext from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "messages": [RetrieveContextMessage.from_dict(_item) for _item in obj["messages"]] if obj.get("messages") is not None else None + }) + return _obj + + diff --git a/vectorize_client/models/retrieve_context_message.py b/vectorize_client/models/retrieve_context_message.py new file mode 100644 index 0000000..1d20454 --- /dev/null +++ b/vectorize_client/models/retrieve_context_message.py @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class RetrieveContextMessage(BaseModel): + """ + RetrieveContextMessage + """ # noqa: E501 + role: StrictStr + content: StrictStr + __properties: ClassVar[List[str]] = ["role", "content"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of RetrieveContextMessage from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of RetrieveContextMessage from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "role": obj.get("role"), + "content": obj.get("content") + }) + return _obj + + diff --git a/vectorize_client/models/retrieve_documents_request.py b/vectorize_client/models/retrieve_documents_request.py new file mode 100644 index 0000000..87b5fb7 --- /dev/null +++ b/vectorize_client/models/retrieve_documents_request.py @@ -0,0 +1,106 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional, Union +from typing_extensions import Annotated +from vectorize_client.models.advanced_query import AdvancedQuery +from vectorize_client.models.retrieve_context import RetrieveContext +from typing import Optional, Set +from typing_extensions import Self + +class RetrieveDocumentsRequest(BaseModel): + """ + RetrieveDocumentsRequest + """ # noqa: E501 + question: StrictStr + num_results: Union[Annotated[float, Field(strict=True, ge=1)], Annotated[int, Field(strict=True, ge=1)]] = Field(alias="numResults") + rerank: Optional[StrictBool] = True + metadata_filters: Optional[List[Dict[str, Any]]] = Field(default=None, alias="metadata-filters") + context: Optional[RetrieveContext] = None + advanced_query: Optional[AdvancedQuery] = Field(default=None, alias="advanced-query") + __properties: ClassVar[List[str]] = ["question", "numResults", "rerank", "metadata-filters", "context", "advanced-query"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of RetrieveDocumentsRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of context + if self.context: + _dict['context'] = self.context.to_dict() + # override the default output from pydantic by calling `to_dict()` of advanced_query + if self.advanced_query: + _dict['advanced-query'] = self.advanced_query.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of RetrieveDocumentsRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "question": obj.get("question"), + "numResults": obj.get("numResults"), + "rerank": obj.get("rerank") if obj.get("rerank") is not None else True, + "metadata-filters": obj.get("metadata-filters"), + "context": RetrieveContext.from_dict(obj["context"]) if obj.get("context") is not None else None, + "advanced-query": AdvancedQuery.from_dict(obj["advanced-query"]) if obj.get("advanced-query") is not None else None + }) + return _obj + + diff --git a/vectorize_client/models/retrieve_documents_response.py b/vectorize_client/models/retrieve_documents_response.py new file mode 100644 index 0000000..0db17a5 --- /dev/null +++ b/vectorize_client/models/retrieve_documents_response.py @@ -0,0 +1,101 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictFloat, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Union +from vectorize_client.models.document import Document +from typing import Optional, Set +from typing_extensions import Self + +class RetrieveDocumentsResponse(BaseModel): + """ + RetrieveDocumentsResponse + """ # noqa: E501 + question: StrictStr + documents: List[Document] + average_relevancy: Union[StrictFloat, StrictInt] + ndcg: Union[StrictFloat, StrictInt] + __properties: ClassVar[List[str]] = ["question", "documents", "average_relevancy", "ndcg"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of RetrieveDocumentsResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in documents (list) + _items = [] + if self.documents: + for _item_documents in self.documents: + if _item_documents: + _items.append(_item_documents.to_dict()) + _dict['documents'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of RetrieveDocumentsResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "question": obj.get("question"), + "documents": [Document.from_dict(_item) for _item in obj["documents"]] if obj.get("documents") is not None else None, + "average_relevancy": obj.get("average_relevancy"), + "ndcg": obj.get("ndcg") + }) + return _obj + + diff --git a/vectorize_client/models/schedule_schema.py b/vectorize_client/models/schedule_schema.py new file mode 100644 index 0000000..3032bf2 --- /dev/null +++ b/vectorize_client/models/schedule_schema.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from vectorize_client.models.schedule_schema_type import ScheduleSchemaType +from typing import Optional, Set +from typing_extensions import Self + +class ScheduleSchema(BaseModel): + """ + ScheduleSchema + """ # noqa: E501 + type: ScheduleSchemaType + __properties: ClassVar[List[str]] = ["type"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ScheduleSchema from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ScheduleSchema from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "type": obj.get("type") + }) + return _obj + + diff --git a/vectorize_client/models/schedule_schema_type.py b/vectorize_client/models/schedule_schema_type.py new file mode 100644 index 0000000..652ebee --- /dev/null +++ b/vectorize_client/models/schedule_schema_type.py @@ -0,0 +1,38 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +from enum import Enum +from typing_extensions import Self + + +class ScheduleSchemaType(str, Enum): + """ + ScheduleSchemaType + """ + + """ + allowed enum values + """ + MANUAL = 'manual' + REALTIME = 'realtime' + CUSTOM = 'custom' + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of ScheduleSchemaType from a JSON string""" + return cls(json.loads(json_str)) + + diff --git a/vectorize_client/models/source_connector.py b/vectorize_client/models/source_connector.py new file mode 100644 index 0000000..deddefc --- /dev/null +++ b/vectorize_client/models/source_connector.py @@ -0,0 +1,112 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class SourceConnector(BaseModel): + """ + SourceConnector + """ # noqa: E501 + id: StrictStr + type: StrictStr + name: StrictStr + config_doc: Optional[Dict[str, Any]] = Field(default=None, alias="configDoc") + created_at: Optional[StrictStr] = Field(default=None, alias="createdAt") + created_by_id: Optional[StrictStr] = Field(default=None, alias="createdById") + last_updated_by_id: Optional[StrictStr] = Field(default=None, alias="lastUpdatedById") + created_by_email: Optional[StrictStr] = Field(default=None, alias="createdByEmail") + last_updated_by_email: Optional[StrictStr] = Field(default=None, alias="lastUpdatedByEmail") + error_message: Optional[StrictStr] = Field(default=None, alias="errorMessage") + verification_status: Optional[StrictStr] = Field(default=None, alias="verificationStatus") + __properties: ClassVar[List[str]] = ["id", "type", "name", "configDoc", "createdAt", "createdById", "lastUpdatedById", "createdByEmail", "lastUpdatedByEmail", "errorMessage", "verificationStatus"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SourceConnector from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # set to None if created_at (nullable) is None + # and model_fields_set contains the field + if self.created_at is None and "created_at" in self.model_fields_set: + _dict['createdAt'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SourceConnector from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "type": obj.get("type"), + "name": obj.get("name"), + "configDoc": obj.get("configDoc"), + "createdAt": obj.get("createdAt"), + "createdById": obj.get("createdById"), + "lastUpdatedById": obj.get("lastUpdatedById"), + "createdByEmail": obj.get("createdByEmail"), + "lastUpdatedByEmail": obj.get("lastUpdatedByEmail"), + "errorMessage": obj.get("errorMessage"), + "verificationStatus": obj.get("verificationStatus") + }) + return _obj + + diff --git a/vectorize_client/models/source_connector_schema.py b/vectorize_client/models/source_connector_schema.py new file mode 100644 index 0000000..7b4b594 --- /dev/null +++ b/vectorize_client/models/source_connector_schema.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from vectorize_client.models.source_connector_type import SourceConnectorType +from typing import Optional, Set +from typing_extensions import Self + +class SourceConnectorSchema(BaseModel): + """ + SourceConnectorSchema + """ # noqa: E501 + id: StrictStr + type: SourceConnectorType + config: Optional[Dict[str, Any]] = None + __properties: ClassVar[List[str]] = ["id", "type", "config"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SourceConnectorSchema from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SourceConnectorSchema from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "type": obj.get("type"), + "config": obj.get("config") + }) + return _obj + + diff --git a/vectorize_client/models/source_connector_type.py b/vectorize_client/models/source_connector_type.py new file mode 100644 index 0000000..776dfaf --- /dev/null +++ b/vectorize_client/models/source_connector_type.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +from enum import Enum +from typing_extensions import Self + + +class SourceConnectorType(str, Enum): + """ + SourceConnectorType + """ + + """ + allowed enum values + """ + AWS_S3 = 'AWS_S3' + AZURE_BLOB = 'AZURE_BLOB' + CONFLUENCE = 'CONFLUENCE' + DISCORD = 'DISCORD' + DROPBOX = 'DROPBOX' + GOOGLE_DRIVE_OAUTH = 'GOOGLE_DRIVE_OAUTH' + GOOGLE_DRIVE = 'GOOGLE_DRIVE' + GOOGLE_DRIVE_OAUTH_MULTI = 'GOOGLE_DRIVE_OAUTH_MULTI' + GOOGLE_DRIVE_OAUTH_MULTI_CUSTOM = 'GOOGLE_DRIVE_OAUTH_MULTI_CUSTOM' + FIRECRAWL = 'FIRECRAWL' + GCS = 'GCS' + INTERCOM = 'INTERCOM' + ONE_DRIVE = 'ONE_DRIVE' + SHAREPOINT = 'SHAREPOINT' + WEB_CRAWLER = 'WEB_CRAWLER' + FILE_UPLOAD = 'FILE_UPLOAD' + SALESFORCE = 'SALESFORCE' + ZENDESK = 'ZENDESK' + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of SourceConnectorType from a JSON string""" + return cls(json.loads(json_str)) + + diff --git a/vectorize_client/models/start_deep_research_request.py b/vectorize_client/models/start_deep_research_request.py new file mode 100644 index 0000000..d1260cc --- /dev/null +++ b/vectorize_client/models/start_deep_research_request.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from vectorize_client.models.n8_n_config import N8NConfig +from typing import Optional, Set +from typing_extensions import Self + +class StartDeepResearchRequest(BaseModel): + """ + StartDeepResearchRequest + """ # noqa: E501 + query: StrictStr + web_search: Optional[StrictBool] = Field(default=False, alias="webSearch") + var_schema: Optional[StrictStr] = Field(default=None, alias="schema") + n8n: Optional[N8NConfig] = None + __properties: ClassVar[List[str]] = ["query", "webSearch", "schema", "n8n"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of StartDeepResearchRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of n8n + if self.n8n: + _dict['n8n'] = self.n8n.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of StartDeepResearchRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "query": obj.get("query"), + "webSearch": obj.get("webSearch") if obj.get("webSearch") is not None else False, + "schema": obj.get("schema"), + "n8n": N8NConfig.from_dict(obj["n8n"]) if obj.get("n8n") is not None else None + }) + return _obj + + diff --git a/vectorize_client/models/start_deep_research_response.py b/vectorize_client/models/start_deep_research_response.py new file mode 100644 index 0000000..e529903 --- /dev/null +++ b/vectorize_client/models/start_deep_research_response.py @@ -0,0 +1,87 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class StartDeepResearchResponse(BaseModel): + """ + StartDeepResearchResponse + """ # noqa: E501 + research_id: StrictStr = Field(alias="researchId") + __properties: ClassVar[List[str]] = ["researchId"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of StartDeepResearchResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of StartDeepResearchResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "researchId": obj.get("researchId") + }) + return _obj + + diff --git a/vectorize_client/models/start_extraction_request.py b/vectorize_client/models/start_extraction_request.py new file mode 100644 index 0000000..5328b38 --- /dev/null +++ b/vectorize_client/models/start_extraction_request.py @@ -0,0 +1,101 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional, Union +from vectorize_client.models.extraction_chunking_strategy import ExtractionChunkingStrategy +from vectorize_client.models.extraction_type import ExtractionType +from vectorize_client.models.metadata_extraction_strategy import MetadataExtractionStrategy +from typing import Optional, Set +from typing_extensions import Self + +class StartExtractionRequest(BaseModel): + """ + StartExtractionRequest + """ # noqa: E501 + file_id: StrictStr = Field(alias="fileId") + type: Optional[ExtractionType] = ExtractionType.IRIS + chunking_strategy: Optional[ExtractionChunkingStrategy] = Field(default=ExtractionChunkingStrategy.MARKDOWN, alias="chunkingStrategy") + chunk_size: Optional[Union[StrictFloat, StrictInt]] = Field(default=256, alias="chunkSize") + metadata: Optional[MetadataExtractionStrategy] = None + __properties: ClassVar[List[str]] = ["fileId", "type", "chunkingStrategy", "chunkSize", "metadata"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of StartExtractionRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of metadata + if self.metadata: + _dict['metadata'] = self.metadata.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of StartExtractionRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "fileId": obj.get("fileId"), + "type": obj.get("type") if obj.get("type") is not None else ExtractionType.IRIS, + "chunkingStrategy": obj.get("chunkingStrategy") if obj.get("chunkingStrategy") is not None else ExtractionChunkingStrategy.MARKDOWN, + "chunkSize": obj.get("chunkSize") if obj.get("chunkSize") is not None else 256, + "metadata": MetadataExtractionStrategy.from_dict(obj["metadata"]) if obj.get("metadata") is not None else None + }) + return _obj + + diff --git a/vectorize_client/models/start_extraction_response.py b/vectorize_client/models/start_extraction_response.py new file mode 100644 index 0000000..d2af70f --- /dev/null +++ b/vectorize_client/models/start_extraction_response.py @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class StartExtractionResponse(BaseModel): + """ + StartExtractionResponse + """ # noqa: E501 + message: StrictStr + extraction_id: StrictStr = Field(alias="extractionId") + __properties: ClassVar[List[str]] = ["message", "extractionId"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of StartExtractionResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of StartExtractionResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "message": obj.get("message"), + "extractionId": obj.get("extractionId") + }) + return _obj + + diff --git a/vectorize_client/models/start_file_upload_request.py b/vectorize_client/models/start_file_upload_request.py new file mode 100644 index 0000000..ecf1bd8 --- /dev/null +++ b/vectorize_client/models/start_file_upload_request.py @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class StartFileUploadRequest(BaseModel): + """ + StartFileUploadRequest + """ # noqa: E501 + name: StrictStr + content_type: StrictStr = Field(alias="contentType") + __properties: ClassVar[List[str]] = ["name", "contentType"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of StartFileUploadRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of StartFileUploadRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "name": obj.get("name"), + "contentType": obj.get("contentType") + }) + return _obj + + diff --git a/vectorize_client/models/start_file_upload_response.py b/vectorize_client/models/start_file_upload_response.py new file mode 100644 index 0000000..8adb7cd --- /dev/null +++ b/vectorize_client/models/start_file_upload_response.py @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class StartFileUploadResponse(BaseModel): + """ + StartFileUploadResponse + """ # noqa: E501 + file_id: StrictStr = Field(alias="fileId") + upload_url: StrictStr = Field(alias="uploadUrl") + __properties: ClassVar[List[str]] = ["fileId", "uploadUrl"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of StartFileUploadResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of StartFileUploadResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "fileId": obj.get("fileId"), + "uploadUrl": obj.get("uploadUrl") + }) + return _obj + + diff --git a/vectorize_client/models/start_file_upload_to_connector_request.py b/vectorize_client/models/start_file_upload_to_connector_request.py new file mode 100644 index 0000000..76c297a --- /dev/null +++ b/vectorize_client/models/start_file_upload_to_connector_request.py @@ -0,0 +1,91 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class StartFileUploadToConnectorRequest(BaseModel): + """ + StartFileUploadToConnectorRequest + """ # noqa: E501 + name: StrictStr + content_type: StrictStr = Field(alias="contentType") + metadata: Optional[StrictStr] = None + __properties: ClassVar[List[str]] = ["name", "contentType", "metadata"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of StartFileUploadToConnectorRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of StartFileUploadToConnectorRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "name": obj.get("name"), + "contentType": obj.get("contentType"), + "metadata": obj.get("metadata") + }) + return _obj + + diff --git a/vectorize_client/models/start_file_upload_to_connector_response.py b/vectorize_client/models/start_file_upload_to_connector_response.py new file mode 100644 index 0000000..bc36de0 --- /dev/null +++ b/vectorize_client/models/start_file_upload_to_connector_response.py @@ -0,0 +1,87 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class StartFileUploadToConnectorResponse(BaseModel): + """ + StartFileUploadToConnectorResponse + """ # noqa: E501 + upload_url: StrictStr = Field(alias="uploadUrl") + __properties: ClassVar[List[str]] = ["uploadUrl"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of StartFileUploadToConnectorResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of StartFileUploadToConnectorResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "uploadUrl": obj.get("uploadUrl") + }) + return _obj + + diff --git a/vectorize_client/models/start_pipeline_response.py b/vectorize_client/models/start_pipeline_response.py new file mode 100644 index 0000000..4169699 --- /dev/null +++ b/vectorize_client/models/start_pipeline_response.py @@ -0,0 +1,87 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class StartPipelineResponse(BaseModel): + """ + StartPipelineResponse + """ # noqa: E501 + message: StrictStr + __properties: ClassVar[List[str]] = ["message"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of StartPipelineResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of StartPipelineResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "message": obj.get("message") + }) + return _obj + + diff --git a/vectorize_client/models/stop_pipeline_response.py b/vectorize_client/models/stop_pipeline_response.py new file mode 100644 index 0000000..68197ca --- /dev/null +++ b/vectorize_client/models/stop_pipeline_response.py @@ -0,0 +1,87 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class StopPipelineResponse(BaseModel): + """ + StopPipelineResponse + """ # noqa: E501 + message: StrictStr + __properties: ClassVar[List[str]] = ["message"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of StopPipelineResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of StopPipelineResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "message": obj.get("message") + }) + return _obj + + diff --git a/vectorize_client/models/update_ai_platform_connector_request.py b/vectorize_client/models/update_ai_platform_connector_request.py new file mode 100644 index 0000000..4422aeb --- /dev/null +++ b/vectorize_client/models/update_ai_platform_connector_request.py @@ -0,0 +1,87 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class UpdateAIPlatformConnectorRequest(BaseModel): + """ + UpdateAIPlatformConnectorRequest + """ # noqa: E501 + config: Dict[str, Any] + __properties: ClassVar[List[str]] = ["config"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of UpdateAIPlatformConnectorRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of UpdateAIPlatformConnectorRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "config": obj.get("config") + }) + return _obj + + diff --git a/vectorize_client/models/update_ai_platform_connector_response.py b/vectorize_client/models/update_ai_platform_connector_response.py new file mode 100644 index 0000000..1e82a2b --- /dev/null +++ b/vectorize_client/models/update_ai_platform_connector_response.py @@ -0,0 +1,93 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List +from vectorize_client.models.updated_ai_platform_connector_data import UpdatedAIPlatformConnectorData +from typing import Optional, Set +from typing_extensions import Self + +class UpdateAIPlatformConnectorResponse(BaseModel): + """ + UpdateAIPlatformConnectorResponse + """ # noqa: E501 + message: StrictStr + data: UpdatedAIPlatformConnectorData + __properties: ClassVar[List[str]] = ["message", "data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of UpdateAIPlatformConnectorResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of UpdateAIPlatformConnectorResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "message": obj.get("message"), + "data": UpdatedAIPlatformConnectorData.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/vectorize_client/models/update_destination_connector_request.py b/vectorize_client/models/update_destination_connector_request.py new file mode 100644 index 0000000..6c366a1 --- /dev/null +++ b/vectorize_client/models/update_destination_connector_request.py @@ -0,0 +1,87 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class UpdateDestinationConnectorRequest(BaseModel): + """ + UpdateDestinationConnectorRequest + """ # noqa: E501 + config: Dict[str, Any] + __properties: ClassVar[List[str]] = ["config"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of UpdateDestinationConnectorRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of UpdateDestinationConnectorRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "config": obj.get("config") + }) + return _obj + + diff --git a/vectorize_client/models/update_destination_connector_response.py b/vectorize_client/models/update_destination_connector_response.py new file mode 100644 index 0000000..571cbf7 --- /dev/null +++ b/vectorize_client/models/update_destination_connector_response.py @@ -0,0 +1,93 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List +from vectorize_client.models.updated_destination_connector_data import UpdatedDestinationConnectorData +from typing import Optional, Set +from typing_extensions import Self + +class UpdateDestinationConnectorResponse(BaseModel): + """ + UpdateDestinationConnectorResponse + """ # noqa: E501 + message: StrictStr + data: UpdatedDestinationConnectorData + __properties: ClassVar[List[str]] = ["message", "data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of UpdateDestinationConnectorResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of UpdateDestinationConnectorResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "message": obj.get("message"), + "data": UpdatedDestinationConnectorData.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/vectorize_client/models/update_source_connector_request.py b/vectorize_client/models/update_source_connector_request.py new file mode 100644 index 0000000..5b72fd8 --- /dev/null +++ b/vectorize_client/models/update_source_connector_request.py @@ -0,0 +1,87 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class UpdateSourceConnectorRequest(BaseModel): + """ + UpdateSourceConnectorRequest + """ # noqa: E501 + config: Dict[str, Any] + __properties: ClassVar[List[str]] = ["config"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of UpdateSourceConnectorRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of UpdateSourceConnectorRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "config": obj.get("config") + }) + return _obj + + diff --git a/vectorize_client/models/update_source_connector_response.py b/vectorize_client/models/update_source_connector_response.py new file mode 100644 index 0000000..b93281c --- /dev/null +++ b/vectorize_client/models/update_source_connector_response.py @@ -0,0 +1,93 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List +from vectorize_client.models.update_source_connector_response_data import UpdateSourceConnectorResponseData +from typing import Optional, Set +from typing_extensions import Self + +class UpdateSourceConnectorResponse(BaseModel): + """ + UpdateSourceConnectorResponse + """ # noqa: E501 + message: StrictStr + data: UpdateSourceConnectorResponseData + __properties: ClassVar[List[str]] = ["message", "data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of UpdateSourceConnectorResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of UpdateSourceConnectorResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "message": obj.get("message"), + "data": UpdateSourceConnectorResponseData.from_dict(obj["data"]) if obj.get("data") is not None else None + }) + return _obj + + diff --git a/vectorize_client/models/update_source_connector_response_data.py b/vectorize_client/models/update_source_connector_response_data.py new file mode 100644 index 0000000..4cce620 --- /dev/null +++ b/vectorize_client/models/update_source_connector_response_data.py @@ -0,0 +1,93 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from vectorize_client.models.source_connector import SourceConnector +from typing import Optional, Set +from typing_extensions import Self + +class UpdateSourceConnectorResponseData(BaseModel): + """ + UpdateSourceConnectorResponseData + """ # noqa: E501 + updated_connector: SourceConnector = Field(alias="updatedConnector") + pipeline_ids: Optional[List[StrictStr]] = Field(default=None, alias="pipelineIds") + __properties: ClassVar[List[str]] = ["updatedConnector", "pipelineIds"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of UpdateSourceConnectorResponseData from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of updated_connector + if self.updated_connector: + _dict['updatedConnector'] = self.updated_connector.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of UpdateSourceConnectorResponseData from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "updatedConnector": SourceConnector.from_dict(obj["updatedConnector"]) if obj.get("updatedConnector") is not None else None, + "pipelineIds": obj.get("pipelineIds") + }) + return _obj + + diff --git a/vectorize_client/models/update_user_in_source_connector_request.py b/vectorize_client/models/update_user_in_source_connector_request.py new file mode 100644 index 0000000..fd194e2 --- /dev/null +++ b/vectorize_client/models/update_user_in_source_connector_request.py @@ -0,0 +1,104 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from vectorize_client.models.add_user_to_source_connector_request_selected_files_value import AddUserToSourceConnectorRequestSelectedFilesValue +from typing import Optional, Set +from typing_extensions import Self + +class UpdateUserInSourceConnectorRequest(BaseModel): + """ + UpdateUserInSourceConnectorRequest + """ # noqa: E501 + user_id: StrictStr = Field(alias="userId") + selected_files: Optional[Dict[str, AddUserToSourceConnectorRequestSelectedFilesValue]] = Field(default=None, alias="selectedFiles") + refresh_token: Optional[StrictStr] = Field(default=None, alias="refreshToken") + __properties: ClassVar[List[str]] = ["userId", "selectedFiles", "refreshToken"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of UpdateUserInSourceConnectorRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each value in selected_files (dict) + _field_dict = {} + if self.selected_files: + for _key_selected_files in self.selected_files: + if self.selected_files[_key_selected_files]: + _field_dict[_key_selected_files] = self.selected_files[_key_selected_files].to_dict() + _dict['selectedFiles'] = _field_dict + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of UpdateUserInSourceConnectorRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "userId": obj.get("userId"), + "selectedFiles": dict( + (_k, AddUserToSourceConnectorRequestSelectedFilesValue.from_dict(_v)) + for _k, _v in obj["selectedFiles"].items() + ) + if obj.get("selectedFiles") is not None + else None, + "refreshToken": obj.get("refreshToken") + }) + return _obj + + diff --git a/vectorize_client/models/update_user_in_source_connector_response.py b/vectorize_client/models/update_user_in_source_connector_response.py new file mode 100644 index 0000000..d55be0a --- /dev/null +++ b/vectorize_client/models/update_user_in_source_connector_response.py @@ -0,0 +1,87 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class UpdateUserInSourceConnectorResponse(BaseModel): + """ + UpdateUserInSourceConnectorResponse + """ # noqa: E501 + message: StrictStr + __properties: ClassVar[List[str]] = ["message"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of UpdateUserInSourceConnectorResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of UpdateUserInSourceConnectorResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "message": obj.get("message") + }) + return _obj + + diff --git a/vectorize_client/models/updated_ai_platform_connector_data.py b/vectorize_client/models/updated_ai_platform_connector_data.py new file mode 100644 index 0000000..058d5bb --- /dev/null +++ b/vectorize_client/models/updated_ai_platform_connector_data.py @@ -0,0 +1,93 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from vectorize_client.models.ai_platform import AIPlatform +from typing import Optional, Set +from typing_extensions import Self + +class UpdatedAIPlatformConnectorData(BaseModel): + """ + UpdatedAIPlatformConnectorData + """ # noqa: E501 + updated_connector: AIPlatform = Field(alias="updatedConnector") + pipeline_ids: Optional[List[StrictStr]] = Field(default=None, alias="pipelineIds") + __properties: ClassVar[List[str]] = ["updatedConnector", "pipelineIds"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of UpdatedAIPlatformConnectorData from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of updated_connector + if self.updated_connector: + _dict['updatedConnector'] = self.updated_connector.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of UpdatedAIPlatformConnectorData from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "updatedConnector": AIPlatform.from_dict(obj["updatedConnector"]) if obj.get("updatedConnector") is not None else None, + "pipelineIds": obj.get("pipelineIds") + }) + return _obj + + diff --git a/vectorize_client/models/updated_destination_connector_data.py b/vectorize_client/models/updated_destination_connector_data.py new file mode 100644 index 0000000..6801526 --- /dev/null +++ b/vectorize_client/models/updated_destination_connector_data.py @@ -0,0 +1,93 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from vectorize_client.models.destination_connector import DestinationConnector +from typing import Optional, Set +from typing_extensions import Self + +class UpdatedDestinationConnectorData(BaseModel): + """ + UpdatedDestinationConnectorData + """ # noqa: E501 + updated_connector: DestinationConnector = Field(alias="updatedConnector") + pipeline_ids: Optional[List[StrictStr]] = Field(default=None, alias="pipelineIds") + __properties: ClassVar[List[str]] = ["updatedConnector", "pipelineIds"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of UpdatedDestinationConnectorData from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of updated_connector + if self.updated_connector: + _dict['updatedConnector'] = self.updated_connector.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of UpdatedDestinationConnectorData from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "updatedConnector": DestinationConnector.from_dict(obj["updatedConnector"]) if obj.get("updatedConnector") is not None else None, + "pipelineIds": obj.get("pipelineIds") + }) + return _obj + + diff --git a/vectorize_client/models/upload_file.py b/vectorize_client/models/upload_file.py new file mode 100644 index 0000000..d4e97ea --- /dev/null +++ b/vectorize_client/models/upload_file.py @@ -0,0 +1,102 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional, Union +from typing import Optional, Set +from typing_extensions import Self + +class UploadFile(BaseModel): + """ + UploadFile + """ # noqa: E501 + key: StrictStr + name: StrictStr + size: Union[StrictFloat, StrictInt] + extension: Optional[StrictStr] = None + last_modified: Optional[StrictStr] = Field(alias="lastModified") + metadata: Dict[str, StrictStr] + __properties: ClassVar[List[str]] = ["key", "name", "size", "extension", "lastModified", "metadata"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of UploadFile from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # set to None if last_modified (nullable) is None + # and model_fields_set contains the field + if self.last_modified is None and "last_modified" in self.model_fields_set: + _dict['lastModified'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of UploadFile from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "key": obj.get("key"), + "name": obj.get("name"), + "size": obj.get("size"), + "extension": obj.get("extension"), + "lastModified": obj.get("lastModified"), + "metadata": obj.get("metadata") + }) + return _obj + + diff --git a/vectorize_client/py.typed b/vectorize_client/py.typed new file mode 100644 index 0000000..e69de29 diff --git a/vectorize_client/rest.py b/vectorize_client/rest.py new file mode 100644 index 0000000..2d60aa0 --- /dev/null +++ b/vectorize_client/rest.py @@ -0,0 +1,258 @@ +# coding: utf-8 + +""" + Vectorize API (Beta) + + API for Vectorize services + + The version of the OpenAPI document: 0.0.1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import io +import json +import re +import ssl + +import urllib3 + +from vectorize_client.exceptions import ApiException, ApiValueError + +SUPPORTED_SOCKS_PROXIES = {"socks5", "socks5h", "socks4", "socks4a"} +RESTResponseType = urllib3.HTTPResponse + + +def is_socks_proxy_url(url): + if url is None: + return False + split_section = url.split("://") + if len(split_section) < 2: + return False + else: + return split_section[0].lower() in SUPPORTED_SOCKS_PROXIES + + +class RESTResponse(io.IOBase): + + def __init__(self, resp) -> None: + self.response = resp + self.status = resp.status + self.reason = resp.reason + self.data = None + + def read(self): + if self.data is None: + self.data = self.response.data + return self.data + + def getheaders(self): + """Returns a dictionary of the response headers.""" + return self.response.headers + + def getheader(self, name, default=None): + """Returns a given response header.""" + return self.response.headers.get(name, default) + + +class RESTClientObject: + + def __init__(self, configuration) -> None: + # urllib3.PoolManager will pass all kw parameters to connectionpool + # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/poolmanager.py#L75 # noqa: E501 + # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/connectionpool.py#L680 # noqa: E501 + # Custom SSL certificates and client certificates: http://urllib3.readthedocs.io/en/latest/advanced-usage.html # noqa: E501 + + # cert_reqs + if configuration.verify_ssl: + cert_reqs = ssl.CERT_REQUIRED + else: + cert_reqs = ssl.CERT_NONE + + pool_args = { + "cert_reqs": cert_reqs, + "ca_certs": configuration.ssl_ca_cert, + "cert_file": configuration.cert_file, + "key_file": configuration.key_file, + "ca_cert_data": configuration.ca_cert_data, + } + if configuration.assert_hostname is not None: + pool_args['assert_hostname'] = ( + configuration.assert_hostname + ) + + if configuration.retries is not None: + pool_args['retries'] = configuration.retries + + if configuration.tls_server_name: + pool_args['server_hostname'] = configuration.tls_server_name + + + if configuration.socket_options is not None: + pool_args['socket_options'] = configuration.socket_options + + if configuration.connection_pool_maxsize is not None: + pool_args['maxsize'] = configuration.connection_pool_maxsize + + # https pool manager + self.pool_manager: urllib3.PoolManager + + if configuration.proxy: + if is_socks_proxy_url(configuration.proxy): + from urllib3.contrib.socks import SOCKSProxyManager + pool_args["proxy_url"] = configuration.proxy + pool_args["headers"] = configuration.proxy_headers + self.pool_manager = SOCKSProxyManager(**pool_args) + else: + pool_args["proxy_url"] = configuration.proxy + pool_args["proxy_headers"] = configuration.proxy_headers + self.pool_manager = urllib3.ProxyManager(**pool_args) + else: + self.pool_manager = urllib3.PoolManager(**pool_args) + + def request( + self, + method, + url, + headers=None, + body=None, + post_params=None, + _request_timeout=None + ): + """Perform requests. + + :param method: http request method + :param url: http request url + :param headers: http request headers + :param body: request json body, for `application/json` + :param post_params: request post parameters, + `application/x-www-form-urlencoded` + and `multipart/form-data` + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + """ + method = method.upper() + assert method in [ + 'GET', + 'HEAD', + 'DELETE', + 'POST', + 'PUT', + 'PATCH', + 'OPTIONS' + ] + + if post_params and body: + raise ApiValueError( + "body parameter cannot be used with post_params parameter." + ) + + post_params = post_params or {} + headers = headers or {} + + timeout = None + if _request_timeout: + if isinstance(_request_timeout, (int, float)): + timeout = urllib3.Timeout(total=_request_timeout) + elif ( + isinstance(_request_timeout, tuple) + and len(_request_timeout) == 2 + ): + timeout = urllib3.Timeout( + connect=_request_timeout[0], + read=_request_timeout[1] + ) + + try: + # For `POST`, `PUT`, `PATCH`, `OPTIONS`, `DELETE` + if method in ['POST', 'PUT', 'PATCH', 'OPTIONS', 'DELETE']: + + # no content type provided or payload is json + content_type = headers.get('Content-Type') + if ( + not content_type + or re.search('json', content_type, re.IGNORECASE) + ): + request_body = None + if body is not None: + request_body = json.dumps(body) + r = self.pool_manager.request( + method, + url, + body=request_body, + timeout=timeout, + headers=headers, + preload_content=False + ) + elif content_type == 'application/x-www-form-urlencoded': + r = self.pool_manager.request( + method, + url, + fields=post_params, + encode_multipart=False, + timeout=timeout, + headers=headers, + preload_content=False + ) + elif content_type == 'multipart/form-data': + # must del headers['Content-Type'], or the correct + # Content-Type which generated by urllib3 will be + # overwritten. + del headers['Content-Type'] + # Ensures that dict objects are serialized + post_params = [(a, json.dumps(b)) if isinstance(b, dict) else (a,b) for a, b in post_params] + r = self.pool_manager.request( + method, + url, + fields=post_params, + encode_multipart=True, + timeout=timeout, + headers=headers, + preload_content=False + ) + # Pass a `string` parameter directly in the body to support + # other content types than JSON when `body` argument is + # provided in serialized form. + elif isinstance(body, str) or isinstance(body, bytes): + r = self.pool_manager.request( + method, + url, + body=body, + timeout=timeout, + headers=headers, + preload_content=False + ) + elif headers['Content-Type'].startswith('text/') and isinstance(body, bool): + request_body = "true" if body else "false" + r = self.pool_manager.request( + method, + url, + body=request_body, + preload_content=False, + timeout=timeout, + headers=headers) + else: + # Cannot generate the request from given parameters + msg = """Cannot prepare a request message for provided + arguments. Please check that your arguments match + declared content type.""" + raise ApiException(status=0, reason=msg) + # For `GET`, `HEAD` + else: + r = self.pool_manager.request( + method, + url, + fields={}, + timeout=timeout, + headers=headers, + preload_content=False + ) + except urllib3.exceptions.SSLError as e: + msg = "\n".join([type(e).__name__, str(e)]) + raise ApiException(status=0, reason=msg) + + return RESTResponse(r)