Module: TrieveRubyClient

Defined in:: lib/trieve_ruby_client/version.rb,
lib/trieve_ruby_client.rb,
lib/trieve_ruby_client/api_error.rb,
lib/trieve_ruby_client/api_client.rb,
lib/trieve_ruby_client/models/file.rb,
lib/trieve_ruby_client/api/auth_api.rb,
lib/trieve_ruby_client/api/file_api.rb,
lib/trieve_ruby_client/api/user_api.rb,
lib/trieve_ruby_client/models/event.rb,
lib/trieve_ruby_client/models/range.rb,
lib/trieve_ruby_client/models/topic.rb,
lib/trieve_ruby_client/api/chunk_api.rb,
lib/trieve_ruby_client/api/topic_api.rb,
lib/trieve_ruby_client/configuration.rb,
lib/trieve_ruby_client/api/events_api.rb,
lib/trieve_ruby_client/api/health_api.rb,
lib/trieve_ruby_client/api/stripe_api.rb,
lib/trieve_ruby_client/models/dataset.rb,
lib/trieve_ruby_client/models/message.rb,
lib/trieve_ruby_client/api/dataset_api.rb,
lib/trieve_ruby_client/api/message_api.rb,
lib/trieve_ruby_client/models/file_dto.rb,
lib/trieve_ruby_client/models/geo_info.rb,
lib/trieve_ruby_client/models/geo_types.rb,
lib/trieve_ruby_client/models/slim_user.rb,
lib/trieve_ruby_client/models/auth_query.rb,
lib/trieve_ruby_client/models/chunk_data.rb,
lib/trieve_ruby_client/models/date_range.rb,
lib/trieve_ruby_client/models/group_data.rb,
lib/trieve_ruby_client/models/slim_group.rb,
lib/trieve_ruby_client/api/invitation_api.rb,
lib/trieve_ruby_client/models/api_key_dto.rb,
lib/trieve_ruby_client/models/chunk_group.rb,
lib/trieve_ruby_client/models/dataset_dto.rb,
lib/trieve_ruby_client/models/stripe_plan.rb,
lib/trieve_ruby_client/api/chunk_group_api.rb,
lib/trieve_ruby_client/models/boost_phrase.rb,
lib/trieve_ruby_client/models/chunk_filter.rb,
lib/trieve_ruby_client/models/event_return.rb,
lib/trieve_ruby_client/models/organization.rb,
lib/trieve_ruby_client/api/organization_api.rb,
lib/trieve_ruby_client/models/bookmark_data.rb,
lib/trieve_ruby_client/models/chunk_metadata.rb,
lib/trieve_ruby_client/models/condition_type.rb,
lib/trieve_ruby_client/models/field_condition.rb,
lib/trieve_ruby_client/models/get_chunks_data.rb,
lib/trieve_ruby_client/models/get_events_data.rb,
lib/trieve_ruby_client/models/invitation_data.rb,
lib/trieve_ruby_client/models/location_radius.rb,
lib/trieve_ruby_client/models/match_condition.rb,
lib/trieve_ruby_client/models/range_condition.rb,
lib/trieve_ruby_client/models/score_chunk_dto.rb,
lib/trieve_ruby_client/models/has_id_condition.rb,
lib/trieve_ruby_client/models/location_polygon.rb,
lib/trieve_ruby_client/models/update_user_data.rb,
lib/trieve_ruby_client/models/upload_file_data.rb,
lib/trieve_ruby_client/models/api_key_resp_body.rb,
lib/trieve_ruby_client/models/autocomplete_data.rb,
lib/trieve_ruby_client/models/chunk_req_payload.rb,
lib/trieve_ruby_client/models/create_chunk_data.rb,
lib/trieve_ruby_client/models/create_topic_data.rb,
lib/trieve_ruby_client/models/dataset_and_usage.rb,
lib/trieve_ruby_client/models/delete_topic_data.rb,
lib/trieve_ruby_client/models/edit_message_data.rb,
lib/trieve_ruby_client/models/group_score_chunk.rb,
lib/trieve_ruby_client/models/score_slim_chunks.rb,
lib/trieve_ruby_client/models/search_chunk_data.rb,
lib/trieve_ruby_client/models/update_chunk_data.rb,
lib/trieve_ruby_client/models/update_topic_data.rb,
lib/trieve_ruby_client/models/user_organization.rb,
lib/trieve_ruby_client/models/chat_message_proxy.rb,
lib/trieve_ruby_client/models/upload_file_result.rb,
lib/trieve_ruby_client/models/create_message_data.rb,
lib/trieve_ruby_client/models/dataset_usage_count.rb,
lib/trieve_ruby_client/models/error_response_body.rb,
lib/trieve_ruby_client/models/return_queued_chunk.rb,
lib/trieve_ruby_client/models/slim_chunk_metadata.rb,
lib/trieve_ruby_client/models/chunk_group_and_file.rb,
lib/trieve_ruby_client/models/chunk_metadata_types.rb,
lib/trieve_ruby_client/models/search_groups_result.rb,
lib/trieve_ruby_client/models/bookmark_group_result.rb,
lib/trieve_ruby_client/models/group_score_chunk_dto.rb,
lib/trieve_ruby_client/models/group_slim_chunks_dto.rb,
lib/trieve_ruby_client/models/location_bounding_box.rb,
lib/trieve_ruby_client/models/content_chunk_metadata.rb,
lib/trieve_ruby_client/models/create_dataset_request.rb,
lib/trieve_ruby_client/models/delete_dataset_request.rb,
lib/trieve_ruby_client/models/update_dataset_request.rb,
lib/trieve_ruby_client/models/add_chunk_to_group_data.rb,
lib/trieve_ruby_client/models/create_chunk_group_data.rb,
lib/trieve_ruby_client/models/generate_chunks_request.rb,
lib/trieve_ruby_client/models/get_datasets_pagination.rb,
lib/trieve_ruby_client/models/group_score_slim_chunks.rb,
lib/trieve_ruby_client/models/regenerate_message_data.rb,
lib/trieve_ruby_client/models/search_over_groups_data.rb,
lib/trieve_ruby_client/models/update_chunk_group_data.rb,
lib/trieve_ruby_client/models/upload_file_req_payload.rb,
lib/trieve_ruby_client/models/autocomplete_req_payload.rb,
lib/trieve_ruby_client/models/create_organization_data.rb,
lib/trieve_ruby_client/models/create_topic_req_payload.rb,
lib/trieve_ruby_client/models/edit_message_req_payload.rb,
lib/trieve_ruby_client/models/get_tracking_chunks_data.rb,
lib/trieve_ruby_client/models/organization_usage_count.rb,
lib/trieve_ruby_client/models/recommend_chunks_request.rb,
lib/trieve_ruby_client/models/search_within_group_data.rb,
lib/trieve_ruby_client/models/set_user_api_key_request.rb,
lib/trieve_ruby_client/models/update_chunk_req_payload.rb,
lib/trieve_ruby_client/models/update_organization_data.rb,
lib/trieve_ruby_client/models/update_topic_req_payload.rb,
lib/trieve_ruby_client/models/chunk_metadata_with_score.rb,
lib/trieve_ruby_client/models/search_chunks_req_payload.rb,
lib/trieve_ruby_client/models/set_user_api_key_response.rb,
lib/trieve_ruby_client/models/suggested_queries_request.rb,
lib/trieve_ruby_client/models/update_user_org_role_data.rb,
lib/trieve_ruby_client/models/create_message_req_payload.rb,
lib/trieve_ruby_client/models/get_groups_for_chunks_data.rb,
lib/trieve_ruby_client/models/search_over_groups_results.rb,
lib/trieve_ruby_client/models/suggested_queries_response.rb,
lib/trieve_ruby_client/models/batch_queued_chunk_response.rb,
lib/trieve_ruby_client/models/delete_user_api_key_request.rb,
lib/trieve_ruby_client/models/search_chunk_response_types.rb,
lib/trieve_ruby_client/models/search_within_group_results.rb,
lib/trieve_ruby_client/models/client_dataset_configuration.rb,
lib/trieve_ruby_client/models/single_queued_chunk_response.rb,
lib/trieve_ruby_client/models/chunk_metadata_string_tag_set.rb,
lib/trieve_ruby_client/models/chunk_metadata_with_file_data.rb,
lib/trieve_ruby_client/models/create_chunk_req_payload_enum.rb,
lib/trieve_ruby_client/models/suggested_queries_req_payload.rb,
lib/trieve_ruby_client/models/create_chunk_group_req_payload.rb,
lib/trieve_ruby_client/models/reccomend_group_chunks_request.rb,
lib/trieve_ruby_client/models/recommend_group_chunks_request.rb,
lib/trieve_ruby_client/models/regenerate_message_req_payload.rb,
lib/trieve_ruby_client/models/slim_chunk_metadata_with_score.rb,
lib/trieve_ruby_client/models/recommend_chunks_response_types.rb,
lib/trieve_ruby_client/models/search_group_slim_chunks_result.rb,
lib/trieve_ruby_client/models/search_over_groups_slim_results.rb,
lib/trieve_ruby_client/models/search_chunk_query_response_body.rb,
lib/trieve_ruby_client/models/search_over_groups_response_body.rb,
lib/trieve_ruby_client/models/search_within_group_slim_results.rb,
lib/trieve_ruby_client/models/update_chunk_by_tracking_id_data.rb,
lib/trieve_ruby_client/models/update_group_by_tracking_id_data.rb,
lib/trieve_ruby_client/models/search_over_groups_response_types.rb,
lib/trieve_ruby_client/models/search_within_group_response_types.rb,
lib/trieve_ruby_client/models/remove_chunk_from_group_req_payload.rb,
lib/trieve_ruby_client/models/recommend_group_chunk_response_types.rb,
lib/trieve_ruby_client/models/search_slim_chunk_query_response_body.rb,
lib/trieve_ruby_client/models/update_group_by_tracking_id_req_payload.rb,
lib/trieve_ruby_client/models/search_over_groups_slim_chunks_response_body.rb

Overview

#Trieve API

#Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.

The version of the OpenAPI document: 0.10.7 Contact: [email protected] Generated by: openapi-generator.tech Generator version: 7.4.0

Defined Under Namespace

Modules: ChunkMetadataTypes, ConditionType, CreateChunkData, CreateChunkReqPayloadEnum, GeoTypes, MatchCondition, RangeCondition, RecommendChunksResponseTypes, RecommendGroupChunkResponseTypes, ReturnQueuedChunk, SearchChunkResponseTypes, SearchOverGroupsResponseTypes, SearchWithinGroupResponseTypes Classes: AddChunkToGroupData, ApiClient, ApiError, ApiKeyDTO, ApiKeyRespBody, AuthApi, AuthQuery, AutocompleteData, AutocompleteReqPayload, BatchQueuedChunkResponse, BookmarkData, BookmarkGroupResult, BoostPhrase, ChatMessageProxy, ChunkApi, ChunkData, ChunkFilter, ChunkGroup, ChunkGroupAndFile, ChunkGroupApi, ChunkMetadata, ChunkMetadataStringTagSet, ChunkMetadataWithFileData, ChunkMetadataWithScore, ChunkReqPayload, ClientDatasetConfiguration, Configuration, ContentChunkMetadata, CreateChunkGroupData, CreateChunkGroupReqPayload, CreateDatasetRequest, CreateMessageData, CreateMessageReqPayload, CreateOrganizationData, CreateTopicData, CreateTopicReqPayload, Dataset, DatasetAndUsage, DatasetApi, DatasetDTO, DatasetUsageCount, DateRange, DeleteDatasetRequest, DeleteTopicData, DeleteUserApiKeyRequest, EditMessageData, EditMessageReqPayload, ErrorResponseBody, Event, EventReturn, EventsApi, FieldCondition, File, FileApi, FileDTO, GenerateChunksRequest, GeoInfo, GetChunksData, GetDatasetsPagination, GetEventsData, GetGroupsForChunksData, GetTrackingChunksData, GroupData, GroupScoreChunk, GroupScoreChunkDTO, GroupScoreSlimChunks, GroupSlimChunksDTO, HasIDCondition, HealthApi, InvitationApi, InvitationData, LocationBoundingBox, LocationPolygon, LocationRadius, Message, MessageApi, Organization, OrganizationApi, OrganizationUsageCount, Range, ReccomendGroupChunksRequest, RecommendChunksRequest, RecommendGroupChunksRequest, RegenerateMessageData, RegenerateMessageReqPayload, RemoveChunkFromGroupReqPayload, ScoreChunkDTO, ScoreSlimChunks, SearchChunkData, SearchChunkQueryResponseBody, SearchChunksReqPayload, SearchGroupSlimChunksResult, SearchGroupsResult, SearchOverGroupsData, SearchOverGroupsResponseBody, SearchOverGroupsResults, SearchOverGroupsSlimChunksResponseBody, SearchOverGroupsSlimResults, SearchSlimChunkQueryResponseBody, SearchWithinGroupData, SearchWithinGroupResults, SearchWithinGroupSlimResults, SetUserApiKeyRequest, SetUserApiKeyResponse, SingleQueuedChunkResponse, SlimChunkMetadata, SlimChunkMetadataWithScore, SlimGroup, SlimUser, StripeApi, StripePlan, SuggestedQueriesReqPayload, SuggestedQueriesRequest, SuggestedQueriesResponse, Topic, TopicApi, UpdateChunkByTrackingIdData, UpdateChunkData, UpdateChunkGroupData, UpdateChunkReqPayload, UpdateDatasetRequest, UpdateGroupByTrackingIDData, UpdateGroupByTrackingIDReqPayload, UpdateOrganizationData, UpdateTopicData, UpdateTopicReqPayload, UpdateUserData, UpdateUserOrgRoleData, UploadFileData, UploadFileReqPayload, UploadFileResult, UserApi, UserOrganization

Constant Summary collapse

VERSION =

'0.10.7'

Class Method Summary collapse

.configure ⇒ Object

Customize default settings for the SDK using block.

Class Method Details

.configure ⇒ `Object`

Customize default settings for the SDK using block.

TrieveRubyClient.configure do |config|
  config.username = "xxx"
  config.password = "xxx"
end

If no block given, return the default Configuration object.

# File 'lib/trieve_ruby_client.rb', line 139

def configure
  if block_given?
    yield(Configuration.default)
  else
    Configuration.default
  end
end