openapi: 3.1.0 info: title: Arthur GenAI Engine Agent Discovery RAG Settings API version: 2.1.688 description: Endpoints for RAG setting management tags: - name: RAG Settings description: Endpoints for RAG setting management paths: /api/v1/tasks/{task_id}/rag_search_settings: post: tags: - RAG Settings summary: Create Rag Search Settings description: Create a new RAG search settings configuration. operationId: create_rag_search_settings security: - API Key: [] parameters: - name: task_id in: path required: true schema: type: string description: ID of the task to create the search settings configuration under. title: Task Id description: ID of the task to create the search settings configuration under. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RagSearchSettingConfigurationRequest' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/RagSearchSettingConfigurationResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' get: tags: - RAG Settings summary: Get Task Rag Search Settings description: Get list of RAG search setting configurations for the task. operationId: get_task_rag_search_settings_api_v1_tasks__task_id__rag_search_settings_get security: - API Key: [] parameters: - name: task_id in: path required: true schema: type: string format: uuid description: ID of the task to fetch the provider connections for. title: Task Id description: ID of the task to fetch the provider connections for. - name: config_name in: query required: false schema: anyOf: - type: string - type: 'null' description: Rag search setting configuration name substring to search for. title: Config Name description: Rag search setting configuration name substring to search for. - name: rag_provider_ids in: query required: false schema: anyOf: - type: array items: type: string format: uuid - type: 'null' description: List of rag provider configuration IDs to filter for. title: Rag Provider Ids description: List of rag provider configuration IDs to filter for. - name: sort in: query required: false schema: $ref: '#/components/schemas/PaginationSortMethod' description: Sort the results (asc/desc) default: desc description: Sort the results (asc/desc) - name: page_size in: query required: false schema: type: integer description: Page size. Default is 10. Must be greater than 0 and less than 5000. default: 10 title: Page Size description: Page size. Default is 10. Must be greater than 0 and less than 5000. - name: page in: query required: false schema: type: integer description: Page number default: 0 title: Page description: Page number responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ListRagSearchSettingConfigurationsResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /api/v1/rag_search_settings/{setting_configuration_id}: get: tags: - RAG Settings summary: Get Rag Search Setting description: Get a single RAG setting configuration. operationId: get_rag_search_setting security: - API Key: [] parameters: - name: setting_configuration_id in: path required: true schema: type: string format: uuid description: ID of RAG search setting configuration. title: Setting Configuration Id description: ID of RAG search setting configuration. responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/RagSearchSettingConfigurationResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' delete: tags: - RAG Settings summary: Delete Rag Search Setting description: Delete a RAG search setting configuration. operationId: delete_rag_search_setting security: - API Key: [] parameters: - name: setting_configuration_id in: path required: true schema: type: string format: uuid description: ID of RAG setting configuration. title: Setting Configuration Id description: ID of RAG setting configuration. responses: '204': description: Successful Response '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' patch: tags: - RAG Settings summary: Update Rag Search Settings description: Update a single RAG search setting configuration. operationId: update_rag_search_settings_api_v1_rag_search_settings__setting_configuration_id__patch security: - API Key: [] parameters: - name: setting_configuration_id in: path required: true schema: type: string format: uuid description: ID of the RAG setting configuration to update. title: Setting Configuration Id description: ID of the RAG setting configuration to update. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RagSearchSettingConfigurationUpdateRequest' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/RagSearchSettingConfigurationResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /api/v1/rag_search_settings/{setting_configuration_id}/versions: post: tags: - RAG Settings summary: Create Rag Search Settings Version description: Create a new version for an existing RAG search settings configuration. operationId: create_rag_search_settings_version security: - API Key: [] parameters: - name: setting_configuration_id in: path required: true schema: type: string format: uuid description: ID of the RAG settings configuration to create the new version for. title: Setting Configuration Id description: ID of the RAG settings configuration to create the new version for. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RagSearchSettingConfigurationNewVersionRequest' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/RagSearchSettingConfigurationVersionResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' get: tags: - RAG Settings summary: Get Rag Search Setting Configuration Versions description: Get list of versions for the RAG search setting configuration. operationId: get_rag_search_setting_configuration_versions_api_v1_rag_search_settings__setting_configuration_id__versions_get security: - API Key: [] parameters: - name: setting_configuration_id in: path required: true schema: type: string format: uuid description: ID of the RAG search setting configuration to get versions for. title: Setting Configuration Id description: ID of the RAG search setting configuration to get versions for. - name: tags in: query required: false schema: anyOf: - type: array items: type: string - type: 'null' description: List of tags to filter for versions tagged with any matching tag. title: Tags description: List of tags to filter for versions tagged with any matching tag. - name: version_numbers in: query required: false schema: anyOf: - type: array items: type: integer - type: 'null' description: List of version numbers to filter for. title: Version Numbers description: List of version numbers to filter for. - name: sort in: query required: false schema: $ref: '#/components/schemas/PaginationSortMethod' description: Sort the results (asc/desc) default: desc description: Sort the results (asc/desc) - name: page_size in: query required: false schema: type: integer description: Page size. Default is 10. Must be greater than 0 and less than 5000. default: 10 title: Page Size description: Page size. Default is 10. Must be greater than 0 and less than 5000. - name: page in: query required: false schema: type: integer description: Page number default: 0 title: Page description: Page number responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ListRagSearchSettingConfigurationVersionsResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /api/v1/rag_search_settings/{setting_configuration_id}/versions/{version_number}: get: tags: - RAG Settings summary: Get Rag Search Setting Version description: Get a single RAG setting configuration version. operationId: get_rag_search_setting_version security: - API Key: [] parameters: - name: setting_configuration_id in: path required: true schema: type: string format: uuid description: ID of RAG search setting configuration. title: Setting Configuration Id description: ID of RAG search setting configuration. - name: version_number in: path required: true schema: type: integer description: Version number of the version to fetch. title: Version Number description: Version number of the version to fetch. responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/RagSearchSettingConfigurationVersionResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' delete: tags: - RAG Settings summary: Delete Rag Search Setting Version description: Soft delete a RAG search setting configuration version. operationId: delete_rag_search_setting_version security: - API Key: [] parameters: - name: setting_configuration_id in: path required: true schema: type: string format: uuid description: ID of RAG search setting configuration. title: Setting Configuration Id description: ID of RAG search setting configuration. - name: version_number in: path required: true schema: type: integer description: Version number of the version to delete. title: Version Number description: Version number of the version to delete. responses: '204': description: Successful Response '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' patch: tags: - RAG Settings summary: Update Rag Search Settings Version description: Update a single RAG search setting configuration version metadata. operationId: update_rag_search_settings_version_api_v1_rag_search_settings__setting_configuration_id__versions__version_number__patch security: - API Key: [] parameters: - name: setting_configuration_id in: path required: true schema: type: string format: uuid description: ID of the RAG search setting configuration to update. title: Setting Configuration Id description: ID of the RAG search setting configuration to update. - name: version_number in: path required: true schema: type: integer description: Version number of the version to update. title: Version Number description: Version number of the version to update. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RagSearchSettingConfigurationVersionUpdateRequest' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/RagSearchSettingConfigurationVersionResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /api/v1/rag_search_settings/{setting_configuration_id}/versions/tags/{tag}: get: tags: - RAG Settings summary: Get Rag Search Setting Version By Tag description: Get a single RAG setting configuration version by tag. operationId: get_rag_search_setting_version_by_tag security: - API Key: [] parameters: - name: setting_configuration_id in: path required: true schema: type: string format: uuid description: ID of RAG search setting configuration. title: Setting Configuration Id description: ID of RAG search setting configuration. - name: tag in: path required: true schema: type: string title: Tag responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/RagSearchSettingConfigurationVersionResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' components: schemas: RagSearchSettingConfigurationRequest: properties: settings: anyOf: - $ref: '#/components/schemas/WeaviateHybridSearchSettingsConfigurationRequest' - $ref: '#/components/schemas/WeaviateKeywordSearchSettingsConfigurationRequest' - $ref: '#/components/schemas/WeaviateVectorSimilarityTextSearchSettingsConfigurationRequest' title: Settings description: Settings configuration for a search request to a RAG provider. rag_provider_id: type: string format: uuid title: Rag Provider Id description: ID of the rag provider to use with the settings. name: type: string title: Name description: Name of the search setting configuration. description: anyOf: - type: string - type: 'null' title: Description description: Description of the search setting configuration. tags: items: type: string type: array title: Tags description: List of tags to configure for this version of the search settings configuration. type: object required: - settings - rag_provider_id - name title: RagSearchSettingConfigurationRequest RagSearchSettingConfigurationNewVersionRequest: properties: settings: anyOf: - $ref: '#/components/schemas/WeaviateHybridSearchSettingsConfigurationRequest' - $ref: '#/components/schemas/WeaviateKeywordSearchSettingsConfigurationRequest' - $ref: '#/components/schemas/WeaviateVectorSimilarityTextSearchSettingsConfigurationRequest' title: Settings description: Settings configuration for a search request to a RAG provider. tags: items: type: string type: array title: Tags description: List of tags to configure for this version of the search settings configuration. type: object required: - settings title: RagSearchSettingConfigurationNewVersionRequest ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type input: title: Input ctx: type: object title: Context type: object required: - loc - msg - type title: ValidationError ListRagSearchSettingConfigurationVersionsResponse: properties: count: type: integer title: Count description: The total number of RAG search setting configuration versions matching the parameters. rag_provider_setting_configurations: items: $ref: '#/components/schemas/RagSearchSettingConfigurationVersionResponse' type: array title: Rag Provider Setting Configurations description: List of RAG search setting configuration versions matching the search filters. Length is less than or equal to page_size parameter type: object required: - count - rag_provider_setting_configurations title: ListRagSearchSettingConfigurationVersionsResponse HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError WeaviateHybridSearchSettingsConfigurationRequest: properties: collection_name: type: string title: Collection Name description: Name of the vector collection used for the search. limit: anyOf: - type: integer - type: 'null' title: Limit description: Maximum number of objects to return. include_vector: anyOf: - type: boolean - type: string - items: type: string type: array - type: 'null' title: Include Vector description: Boolean value whether to include vector embeddings in the response or can be used to specify the names of the vectors to include in the response if your collection uses named vectors. Will be included as a dictionary in the vector property in the response. default: false offset: anyOf: - type: integer - type: 'null' title: Offset description: Skips first N results in similarity response. Useful for pagination. auto_limit: anyOf: - type: integer - type: 'null' title: Auto Limit description: Automatically limit search results to groups of objects with similar distances, stopping after auto_limit number of significant jumps. return_metadata: anyOf: - items: type: string enum: - creation_time - last_update_time - distance - certainty - score - explain_score - is_consistent - query_profile type: array - $ref: '#/components/schemas/MetadataQuery' - type: 'null' title: Return Metadata description: Specify metadata fields to return. return_properties: anyOf: - items: type: string type: array - type: 'null' title: Return Properties description: Specify which properties to return for each object. rag_provider: type: string const: weaviate title: Rag Provider default: weaviate alpha: type: number title: Alpha description: Balance between the relative weights of the keyword and vector search. 1 is pure vector search, 0 is pure keyword search. default: 0.7 query_properties: anyOf: - items: type: string type: array - type: 'null' title: Query Properties description: Apply keyword search to only a specified subset of object properties. fusion_type: anyOf: - $ref: '#/components/schemas/HybridFusion' - type: 'null' description: Set the fusion algorithm to use. Default is Relative Score Fusion. max_vector_distance: anyOf: - type: number - type: 'null' title: Max Vector Distance description: Maximum threshold for the vector search component. minimum_match_or_operator: anyOf: - type: integer - type: 'null' title: Minimum Match Or Operator description: Minimum number of keywords that define a match. Objects returned will have to have at least this many matches. Applies to keyword search only. and_operator: anyOf: - type: boolean - type: 'null' title: And Operator description: Search returns objects that contain all tokens in the search string. Cannot be used with minimum_match_or_operator. Applies to keyword search only. target_vector: anyOf: - type: string - items: type: string type: array - $ref: '#/components/schemas/_MultiTargetVectorJoin' - type: 'null' title: Target Vector description: Specifies vector to use for vector search when using named vectors. search_kind: type: string const: hybrid_search title: Search Kind default: hybrid_search type: object required: - collection_name title: WeaviateHybridSearchSettingsConfigurationRequest RagSearchSettingConfigurationVersionUpdateRequest: properties: tags: items: type: string type: array title: Tags description: List of tags to update this version of the search settings configuration with. type: object required: - tags title: RagSearchSettingConfigurationVersionUpdateRequest ListRagSearchSettingConfigurationsResponse: properties: count: type: integer title: Count description: The total number of RAG search setting configurations matching the parameters. rag_provider_setting_configurations: items: $ref: '#/components/schemas/RagSearchSettingConfigurationResponse' type: array title: Rag Provider Setting Configurations description: List of RAG search setting configurations matching the search filters. Length is less than or equal to page_size parameter type: object required: - count - rag_provider_setting_configurations title: ListRagSearchSettingConfigurationsResponse MetadataQuery: properties: creation_time: type: boolean title: Creation Time default: false last_update_time: type: boolean title: Last Update Time default: false distance: type: boolean title: Distance default: false certainty: type: boolean title: Certainty default: false score: type: boolean title: Score default: false explain_score: type: boolean title: Explain Score default: false is_consistent: type: boolean title: Is Consistent default: false query_profile: type: boolean title: Query Profile default: false additionalProperties: false type: object title: MetadataQuery description: Define which metadata should be returned in the query's results. WeaviateHybridSearchSettingsConfigurationResponse: properties: collection_name: type: string title: Collection Name description: Name of the vector collection used for the search. limit: anyOf: - type: integer - type: 'null' title: Limit description: Maximum number of objects to return. include_vector: anyOf: - type: boolean - type: string - items: type: string type: array - type: 'null' title: Include Vector description: Boolean value whether to include vector embeddings in the response or can be used to specify the names of the vectors to include in the response if your collection uses named vectors. Will be included as a dictionary in the vector property in the response. default: false offset: anyOf: - type: integer - type: 'null' title: Offset description: Skips first N results in similarity response. Useful for pagination. auto_limit: anyOf: - type: integer - type: 'null' title: Auto Limit description: Automatically limit search results to groups of objects with similar distances, stopping after auto_limit number of significant jumps. return_metadata: anyOf: - items: type: string enum: - creation_time - last_update_time - distance - certainty - score - explain_score - is_consistent - query_profile type: array - $ref: '#/components/schemas/MetadataQuery' - type: 'null' title: Return Metadata description: Specify metadata fields to return. return_properties: anyOf: - items: type: string type: array - type: 'null' title: Return Properties description: Specify which properties to return for each object. rag_provider: type: string const: weaviate title: Rag Provider default: weaviate search_kind: type: string const: hybrid_search title: Search Kind default: hybrid_search alpha: type: number title: Alpha description: Balance between the relative weights of the keyword and vector search. 1 is pure vector search, 0 is pure keyword search. default: 0.7 query_properties: anyOf: - items: type: string type: array - type: 'null' title: Query Properties description: Apply keyword search to only a specified subset of object properties. fusion_type: anyOf: - $ref: '#/components/schemas/HybridFusion' - type: 'null' description: Set the fusion algorithm to use. Default is Relative Score Fusion. max_vector_distance: anyOf: - type: number - type: 'null' title: Max Vector Distance description: Maximum threshold for the vector search component. minimum_match_or_operator: anyOf: - type: integer - type: 'null' title: Minimum Match Or Operator description: Minimum number of keywords that define a match. Objects returned will have to have at least this many matches. Applies to keyword search only. and_operator: anyOf: - type: boolean - type: 'null' title: And Operator description: Search returns objects that contain all tokens in the search string. Cannot be used with minimum_match_or_operator. Applies to keyword search only. target_vector: anyOf: - type: string - items: type: string type: array - $ref: '#/components/schemas/_MultiTargetVectorJoin' - type: 'null' title: Target Vector description: Specifies vector to use for vector search when using named vectors. type: object required: - collection_name title: WeaviateHybridSearchSettingsConfigurationResponse _MultiTargetVectorJoin: properties: combination: $ref: '#/components/schemas/_MultiTargetVectorJoinEnum' target_vectors: items: type: string type: array title: Target Vectors weights: anyOf: - additionalProperties: anyOf: - type: number - items: type: number type: array type: object - type: 'null' title: Weights type: object required: - combination - target_vectors title: _MultiTargetVectorJoin WeaviateKeywordSearchSettingsConfigurationResponse: properties: collection_name: type: string title: Collection Name description: Name of the vector collection used for the search. limit: anyOf: - type: integer - type: 'null' title: Limit description: Maximum number of objects to return. include_vector: anyOf: - type: boolean - type: string - items: type: string type: array - type: 'null' title: Include Vector description: Boolean value whether to include vector embeddings in the response or can be used to specify the names of the vectors to include in the response if your collection uses named vectors. Will be included as a dictionary in the vector property in the response. default: false offset: anyOf: - type: integer - type: 'null' title: Offset description: Skips first N results in similarity response. Useful for pagination. auto_limit: anyOf: - type: integer - type: 'null' title: Auto Limit description: Automatically limit search results to groups of objects with similar distances, stopping after auto_limit number of significant jumps. return_metadata: anyOf: - items: type: string enum: - creation_time - last_update_time - distance - certainty - score - explain_score - is_consistent - query_profile type: array - $ref: '#/components/schemas/MetadataQuery' - type: 'null' title: Return Metadata description: Specify metadata fields to return. return_properties: anyOf: - items: type: string type: array - type: 'null' title: Return Properties description: Specify which properties to return for each object. rag_provider: type: string const: weaviate title: Rag Provider default: weaviate search_kind: type: string const: keyword_search title: Search Kind default: keyword_search minimum_match_or_operator: anyOf: - type: integer - type: 'null' title: Minimum Match Or Operator description: Minimum number of keywords that define a match. Objects returned will have to have at least this many matches. and_operator: anyOf: - type: boolean - type: 'null' title: And Operator description: Search returns objects that contain all tokens in the search string. Cannot be used with minimum_match_or_operator type: object required: - collection_name title: WeaviateKeywordSearchSettingsConfigurationResponse PaginationSortMethod: type: string enum: - asc - desc title: PaginationSortMethod WeaviateVectorSimilarityTextSearchSettingsConfigurationResponse: properties: collection_name: type: string title: Collection Name description: Name of the vector collection used for the search. limit: anyOf: - type: integer - type: 'null' title: Limit description: Maximum number of objects to return. include_vector: anyOf: - type: boolean - type: string - items: type: string type: array - type: 'null' title: Include Vector description: Boolean value whether to include vector embeddings in the response or can be used to specify the names of the vectors to include in the response if your collection uses named vectors. Will be included as a dictionary in the vector property in the response. default: false offset: anyOf: - type: integer - type: 'null' title: Offset description: Skips first N results in similarity response. Useful for pagination. auto_limit: anyOf: - type: integer - type: 'null' title: Auto Limit description: Automatically limit search results to groups of objects with similar distances, stopping after auto_limit number of significant jumps. return_metadata: anyOf: - items: type: string enum: - creation_time - last_update_time - distance - certainty - score - explain_score - is_consistent - query_profile type: array - $ref: '#/components/schemas/MetadataQuery' - type: 'null' title: Return Metadata description: Specify metadata fields to return. return_properties: anyOf: - items: type: string type: array - type: 'null' title: Return Properties description: Specify which properties to return for each object. rag_provider: type: string const: weaviate title: Rag Provider default: weaviate search_kind: type: string const: vector_similarity_text_search title: Search Kind default: vector_similarity_text_search certainty: anyOf: - type: number maximum: 1.0 minimum: 0.0 - type: 'null' title: Certainty description: Minimum similarity score to return. Higher values correspond to more similar results. Only one of distance and certainty can be specified. distance: anyOf: - type: number - type: 'null' title: Distance description: Maximum allowed distance between the query and result vectors. Lower values corresponds to more similar results. Only one of distance and certainty can be specified. target_vector: anyOf: - type: string - items: type: string type: array - $ref: '#/components/schemas/_MultiTargetVectorJoin' - type: 'null' title: Target Vector description: Specifies vector to use for similarity search when using named vectors. type: object required: - collection_name title: WeaviateVectorSimilarityTextSearchSettingsConfigurationResponse _MultiTargetVectorJoinEnum: type: integer enum: - 1 - 2 - 3 - 4 - 5 title: _MultiTargetVectorJoinEnum description: Define how multi target vector searches should be combined. RagSearchSettingConfigurationUpdateRequest: properties: name: anyOf: - type: string - type: 'null' title: Name description: Name of the setting configuration. description: anyOf: - type: string - type: 'null' title: Description description: Description of the setting configuration. rag_provider_id: anyOf: - type: string format: uuid - type: 'null' title: Rag Provider Id description: ID of the rag provider configuration to use the settings with. type: object title: RagSearchSettingConfigurationUpdateRequest RagSearchSettingConfigurationResponse: properties: id: type: string format: uuid title: Id description: ID of the setting configuration. task_id: type: string title: Task Id description: ID of the parent task. rag_provider_id: anyOf: - type: string format: uuid - type: 'null' title: Rag Provider Id description: ID of the rag provider to use with the settings. None if initial rag provider configuration was deleted. name: type: string title: Name description: Name of the setting configuration. description: anyOf: - type: string - type: 'null' title: Description description: Description of the setting configuration. latest_version_number: type: integer title: Latest Version Number description: The latest version number of the settings configuration. latest_version: $ref: '#/components/schemas/RagSearchSettingConfigurationVersionResponse' description: The latest version of the settings configuration. all_possible_tags: anyOf: - items: type: string type: array - type: 'null' title: All Possible Tags description: Set of all tags applied for any version of the settings configuration. created_at: type: integer title: Created At description: Time the RAG settings configuration was created in unix milliseconds. updated_at: type: integer title: Updated At description: Time the RAG settings configuration was updated in unix milliseconds. Will be updated if a new version of the configuration was created. type: object required: - id - task_id - name - latest_version_number - latest_version - created_at - updated_at title: RagSearchSettingConfigurationResponse HybridFusion: type: string enum: - FUSION_TYPE_RANKED - FUSION_TYPE_RELATIVE_SCORE title: HybridFusion description: Define how the query's hybrid fusion operation should be performed. WeaviateVectorSimilarityTextSearchSettingsConfigurationRequest: properties: collection_name: type: string title: Collection Name description: Name of the vector collection used for the search. limit: anyOf: - type: integer - type: 'null' title: Limit description: Maximum number of objects to return. include_vector: anyOf: - type: boolean - type: string - items: type: string type: array - type: 'null' title: Include Vector description: Boolean value whether to include vector embeddings in the response or can be used to specify the names of the vectors to include in the response if your collection uses named vectors. Will be included as a dictionary in the vector property in the response. default: false offset: anyOf: - type: integer - type: 'null' title: Offset description: Skips first N results in similarity response. Useful for pagination. auto_limit: anyOf: - type: integer - type: 'null' title: Auto Limit description: Automatically limit search results to groups of objects with similar distances, stopping after auto_limit number of significant jumps. return_metadata: anyOf: - items: type: string enum: - creation_time - last_update_time - distance - certainty - score - explain_score - is_consistent - query_profile type: array - $ref: '#/components/schemas/MetadataQuery' - type: 'null' title: Return Metadata description: Specify metadata fields to return. return_properties: anyOf: - items: type: string type: array - type: 'null' title: Return Properties description: Specify which properties to return for each object. rag_provider: type: string const: weaviate title: Rag Provider default: weaviate certainty: anyOf: - type: number maximum: 1.0 minimum: 0.0 - type: 'null' title: Certainty description: Minimum similarity score to return. Higher values correspond to more similar results. Only one of distance and certainty can be specified. distance: anyOf: - type: number - type: 'null' title: Distance description: Maximum allowed distance between the query and result vectors. Lower values corresponds to more similar results. Only one of distance and certainty can be specified. target_vector: anyOf: - type: string - items: type: string type: array - $ref: '#/components/schemas/_MultiTargetVectorJoin' - type: 'null' title: Target Vector description: Specifies vector to use for similarity search when using named vectors. search_kind: type: string const: vector_similarity_text_search title: Search Kind default: vector_similarity_text_search type: object required: - collection_name title: WeaviateVectorSimilarityTextSearchSettingsConfigurationRequest WeaviateKeywordSearchSettingsConfigurationRequest: properties: collection_name: type: string title: Collection Name description: Name of the vector collection used for the search. limit: anyOf: - type: integer - type: 'null' title: Limit description: Maximum number of objects to return. include_vector: anyOf: - type: boolean - type: string - items: type: string type: array - type: 'null' title: Include Vector description: Boolean value whether to include vector embeddings in the response or can be used to specify the names of the vectors to include in the response if your collection uses named vectors. Will be included as a dictionary in the vector property in the response. default: false offset: anyOf: - type: integer - type: 'null' title: Offset description: Skips first N results in similarity response. Useful for pagination. auto_limit: anyOf: - type: integer - type: 'null' title: Auto Limit description: Automatically limit search results to groups of objects with similar distances, stopping after auto_limit number of significant jumps. return_metadata: anyOf: - items: type: string enum: - creation_time - last_update_time - distance - certainty - score - explain_score - is_consistent - query_profile type: array - $ref: '#/components/schemas/MetadataQuery' - type: 'null' title: Return Metadata description: Specify metadata fields to return. return_properties: anyOf: - items: type: string type: array - type: 'null' title: Return Properties description: Specify which properties to return for each object. rag_provider: type: string const: weaviate title: Rag Provider default: weaviate minimum_match_or_operator: anyOf: - type: integer - type: 'null' title: Minimum Match Or Operator description: Minimum number of keywords that define a match. Objects returned will have to have at least this many matches. and_operator: anyOf: - type: boolean - type: 'null' title: And Operator description: Search returns objects that contain all tokens in the search string. Cannot be used with minimum_match_or_operator search_kind: type: string const: keyword_search title: Search Kind default: keyword_search type: object required: - collection_name title: WeaviateKeywordSearchSettingsConfigurationRequest RagSearchSettingConfigurationVersionResponse: properties: setting_configuration_id: type: string format: uuid title: Setting Configuration Id description: ID of the parent setting configuration. version_number: type: integer title: Version Number description: Version number of the setting configuration. tags: anyOf: - items: type: string type: array - type: 'null' title: Tags description: Optional list of tags configured for this version of the settings configuration. settings: anyOf: - $ref: '#/components/schemas/WeaviateHybridSearchSettingsConfigurationResponse' - $ref: '#/components/schemas/WeaviateVectorSimilarityTextSearchSettingsConfigurationResponse' - $ref: '#/components/schemas/WeaviateKeywordSearchSettingsConfigurationResponse' - type: 'null' title: Settings description: Settings configuration for a search request to a RAG provider. None if version has been soft-deleted. created_at: type: integer title: Created At description: Time the RAG provider settings configuration version was created in unix milliseconds updated_at: type: integer title: Updated At description: Time the RAG provider settings configuration version was updated in unix milliseconds deleted_at: anyOf: - type: integer - type: 'null' title: Deleted At description: Time the RAG provider settings configuration version was soft-deleted in unix milliseconds type: object required: - setting_configuration_id - version_number - created_at - updated_at title: RagSearchSettingConfigurationVersionResponse securitySchemes: API Key: type: http description: Bearer token authentication with an API key scheme: bearer