Github
Preparing search index...
The search index is not available
Trieve Typescript SDK - v0.0.73
Trieve Typescript SDK
Organization Methods
createOrganizationApiKey
Function createOrganizationApiKey
create
Organization
Api
Key
(
props
,
signal
?
)
:
Promise
<
CreateApiKeyResponse
>
Parameters
props
:
CreateApiKeyReqPayload
Optional
signal
:
AbortSignal
Returns
Promise
<
CreateApiKeyResponse
>
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
Github
Trieve Typescript SDK - v0.0.73
Analytics Methods
getAllAnalyticsEvents
getClusterAnalytics
getComponentAnalytics
getCTRAnalytics
getRagAnalytics
getRecommendationAnalytics
getSearchAnalytics
getTopDatasets
rateRagQuery
rateSearchQuery
sendAnalyticsEvent
sendCTRAnalytics
Chunk Methods
autocomplete
countChunksAboveThreshold
createChunk
deleteChunkById
deleteChunkByTrackingId
getChunkById
getChunkByTrackingId
getChunksByIds
getChunksByTrackingIds
getRecommendedChunks
ragOnChunk
ragOnChunkReader
ragOnChunkReaderWithQueryId
scroll
search
splitChunkHtml
suggestedQueries
updateChunk
updateChunkByTrackingId
Crawl Methods
getCrawlsForDataset
Dataset Methods
batchCreateDatasets
clearDataset
createDataset
deleteDataset
getAllDatasetTags
getDatasetById
getDatasetByTrackingId
getDatasetEvents
getDatasetFiles
getDatasetsFromOrganization
getDatasetUsageById
getPagefindUrl
updateDataset
Event Methods
getEventsForDataset
File Methods
createPresignedUrlForCsvJsonl
deleteFile
getFile
getFilesForDataset
scrollFiles
uploadFile
Group Methods
addChunkToGroup
addChunkToGroupByTrackingId
createChunkGroup
deleteGroup
deleteGroupByTrackingId
getChunksGroupByTrackingId
getChunksInGroup
getGroup
getGroupByTrackingId
getGroupsForChunks
getGroupsForDataset
recommendedGroups
removeChunkFromGroup
searchInGroup
searchOverGroups
updateGroup
Messages Methods
createMessage
createMessageReader
createMessageReaderWithQueryId
editMessage
editMessageReader
editMessageReaderWithQueryId
getAllMessagesForTopic
getCleanFetch
getMessageById
getToolCallFunctionParams
regenerateMessage
regenerateMessageReader
regenerateMessageReaderWithQueryId
Organization Methods
createOrganizationApiKey
deleteOrganizationApiKey
getOrganizationById
Stripe Methods
getStripePlans
startStripeCheckout
Topic Methods
cloneTopic
createTopic
deleteTopic
getAllTopics
updateTopic
types.gen
$OpenApiTs
AddChunkToGroupByTrackingIdData
AddChunkToGroupByTrackingIdResponse
AddChunkToGroupData
AddChunkToGroupReqPayload
AddChunkToGroupResponse
ApiKeyRequestParams
ApiKeyRespBody
APIVersion
AuthQuery
AutocompleteData
AutocompleteReqPayload
AutocompleteResponse
BatchCreateDatasetsData
BatchCreateDatasetsResponse
BatchQueuedChunkResponse
BillingEstimate
BillItem
BulkDeleteChunkData
BulkDeleteChunkPayload
BulkDeleteChunkResponse
ButtonTrigger
CallbackResponse
CancelSubscriptionData
CancelSubscriptionResponse
ChatAverageRatingResponse
ChatConversionRateResponse
ChatMessageProxy
ChatRevenueResponse
ChunkedContent
ChunkFilter
ChunkGroup
ChunkGroupAndFileId
ChunkGroups
ChunkHtmlContentReqPayload
ChunkMetadata
ChunkMetadataStringTagSet
ChunkMetadataTypes
ChunkMetadataWithPosition
ChunkMetadataWithScore
ChunkReqPayload
ChunkReqPayloadFields
ChunkReqPayloadMapping
ChunkReqPayloadMappings
ChunkReturnTypes
ChunkWithPosition
ClearDatasetData
ClearDatasetResponse
ClickhouseRagTypes
ClickhouseRecommendationTypes
ClickhouseSearchTypes
CloneTopicData
CloneTopicReqPayload
CloneTopicResponse
ClusterAnalytics
ClusterAnalyticsFilter
ClusterAnalyticsResponse
ComponentAnalytics
ComponentAnalyticsFilter
ComponentAnalyticsResponse
ComponentInteractionTimeResponse
ComponentNamesResponse
ConditionType
ContentChunkMetadata
ContextOptions
CountChunkQueryResponseBody
CountChunksData
CountChunksReqPayload
CountChunksResponse
CountGroupChunksData
CountGroupChunksResponse
CountSearchMethod
CrawlInterval
CrawlOpenAPIOptions
CrawlOptions
CrawlRequest
CrawlShopifyOptions
CrawlStatus
CrawlType
CrawlYoutubeOptions
CreateApiKeyReqPayload
CreateApiKeyResponse
CreateBatchChunkGroupReqPayload
CreateBatchChunkReqPayload
CreateBatchDataset
CreateChunkData
CreateChunkGroupData
CreateChunkGroupReqPayloadEnum
CreateChunkGroupResponse
CreateChunkGroupResponseEnum
CreateChunkReqPayloadEnum
CreateChunkResponse
CreateCrawlData
CreateCrawlReqPayload
CreateCrawlResponse
CreateDatasetBatchReqPayload
CreateDatasetData
CreateDatasetReqPayload
CreateDatasetResponse
CreateEtlJobData
CreateEtlJobResponse
CreateMessageData
CreateMessageReqPayload
CreateMessageResponse
CreateOrganizationApiKeyData
CreateOrganizationApiKeyResponse
CreateOrganizationData
CreateOrganizationReqPayload
CreateOrganizationResponse
CreatePagefindIndexForDatasetData
CreatePagefindIndexForDatasetResponse
CreatePresignedUrlForCsvJsonlData
CreatePresignedUrlForCsvJsonlReqPayload
CreatePresignedUrlForCsvJsonlResponse
CreatePresignedUrlForCsvJsonResponseBody
CreateSchemaReqPayload
CreateSetupCheckoutSessionResPayload
CreateSingleChunkGroupReqPayload
CreateSingleChunkReqPayload
CreateTopicData
CreateTopicReqPayload
CreateTopicResponse
CTRAnalytics
CTRAnalyticsResponse
CTRDataRequestBody
CTRMetricsOverTimeResponse
CTRRecommendationsWithClicksResponse
CTRRecommendationsWithoutClicksResponse
CTRSearchQueryWithClicksResponse
CTRSearchQueryWithoutClicksResponse
CTRType
Dataset
DatasetAnalytics
DatasetAndUsage
DatasetConfigurationDTO
DatasetDTO
DatasetFilePathParams
Datasets
DatasetUsageCount
DateRange
DeleteChunkByTrackingIdData
DeleteChunkByTrackingIdResponse
DeleteChunkData
DeleteChunkGroupData
DeleteChunkGroupResponse
DeleteChunkResponse
DeleteCrawlRequestData
DeleteCrawlRequestResponse
DeleteDatasetByTrackingIdData
DeleteDatasetByTrackingIdResponse
DeleteDatasetData
DeleteDatasetResponse
DeleteFileHandlerData
DeleteFileHandlerResponse
DeleteGroupByTrackingIdData
DeleteGroupByTrackingIdResponse
DeleteInvitationData
DeleteInvitationResponse
DeleteOrganizationApiKeyData
DeleteOrganizationApiKeyResponse
DeleteOrganizationData
DeleteOrganizationResponse
DeleteTopicData
DeleteTopicData2
DeleteTopicResponse
DeleteUserApiKeyData
DeleteUserApiKeyResponse
DeprecatedSearchOverGroupsResponseBody
DirectToPaymentLinkData
DistanceMetric
Document
EditMessageData
EditMessageReqPayload
EditMessageResponse
ErrorResponseBody
EstimateBillFromRangeData
EstimateBillFromRangeResponse
event_type
EventAnalyticsFilter
EventData
EventNameAndCounts
EventNameAndCountsResponse
EventReturn
EventsForTopicResponse
EventTypeRequest
EventTypes
EventTypesFilter
ExtendedOrganizationUsageCount
FieldCondition
File
FileAndGroupId
FileData
FileDTO
FileWithChunkGroups
FloatRange
FloatTimePoint
FollowupQueriesResponse
FollowupQuery
FullTextBoost
GenerateOffChunksData
GenerateOffChunksReqPayload
GenerateOffChunksResponse
GeoInfo
GeoInfoWithBias
GeoTypes
GetAllEventsData
GetAllEventsResponse
GetAllInvoicesData
GetAllInvoicesResponse
GetAllPlansResponse
GetAllTagsData
GetAllTagsReqPayload
GetAllTagsResponse
GetAllTagsResponse2
GetAllTopicMessagesData
GetAllTopicMessagesResponse
GetAllTopicsForOwnerIdData
GetAllTopicsForOwnerIdResponse
GetAllUsagePlansResponse
GetChunkByIdData
GetChunkByIdResponse
GetChunkByTrackingIdData
GetChunkByTrackingIdResponse
GetChunkGroupCountRequest
GetChunkGroupCountResponse
GetChunkGroupData
GetChunkGroupResponse
GetChunksByIdsData
GetChunksByIdsResponse
GetChunksByTrackingIdsData
GetChunksByTrackingIdsResponse
GetChunksData
GetChunksInGroupByTrackingIdData
GetChunksInGroupByTrackingIdResponse
GetChunksInGroupData
GetChunksInGroupResponse
GetChunksInGroupResponse2
GetChunksInGroupsResponseBody
GetClusterAnalyticsData
GetClusterAnalyticsResponse
GetComponentAnalyticsData
GetComponentAnalyticsResponse
GetCrawlRequestsForDatasetData
GetCrawlRequestsForDatasetResponse
GetCrawlRequestsReqPayload
GetCtrAnalyticsData
GetCtrAnalyticsResponse
GetDatasetByTrackingIdData
GetDatasetByTrackingIdResponse
GetDatasetData
GetDatasetFilesAndGroupIdsHandlerData
GetDatasetFilesAndGroupIdsHandlerResponse
GetDatasetResponse
GetDatasetsFromOrganizationData
GetDatasetsFromOrganizationResponse
GetDatasetsPagination
GetEventByIdData
GetEventByIdResponse
GetEventCountsRequestBody
GetEventsData
GetEventsData2
GetEventsRequestBody
GetEventsResponse
GetEventsResponseBody
GetFileHandlerData
GetFileHandlerResponse
GetFilesCursorHandlerData
GetFilesCursorHandlerResponse
GetFilesCursorReqQuery
GetFilesCursorResponseBody
GetGroupByTrackingIdData
GetGroupByTrackingIdResponse
GetGroupsForChunksData
GetGroupsForChunksReqPayload
GetGroupsForChunksResponse
GetGroupsForDatasetData
GetGroupsForDatasetResponse
GetInvitationsData
GetInvitationsResponse
GetMeResponse
GetMessageByIdData
GetMessageByIdResponse
GetMetricsResponse
GetOrganizationApiKeysData
GetOrganizationApiKeysResponse
GetOrganizationData
GetOrganizationResponse
GetOrganizationUsageData
GetOrganizationUsageReqPayload
GetOrganizationUsageResponse
GetOrganizationUsersData
GetOrganizationUsersResponse
GetPagefindIndexForDatasetData
GetPagefindIndexForDatasetResponse
GetPagefindIndexResponse
GetRagAnalyticsData
GetRagAnalyticsResponse
GetRecommendationAnalyticsData
GetRecommendationAnalyticsResponse
GetRecommendedChunksData
GetRecommendedChunksResponse
GetRecommendedGroupsData
GetRecommendedGroupsResponse
GetSearchAnalyticsData
GetSearchAnalyticsResponse
GetSuggestedQueriesData
GetSuggestedQueriesResponse
GetToolFunctionParamsData
GetToolFunctionParamsReqPayload
GetToolFunctionParamsRespBody
GetToolFunctionParamsResponse
GetTopDatasetsData
GetTopDatasetsRequestBody
GetTopDatasetsResponse
GetTrackingChunksData
GetUsageByDatasetIdData
GetUsageByDatasetIdResponse
GetUserApiKeysResponse
Granularity
GroupData
GroupsBookmarkQueryResult
GroupScoreChunk
GroupsForChunk
HasChunkIDCondition
HeadQueries
HeadQueryResponse
HealthCheckResponse
HeroPattern
HighlightOptions
HighlightStrategy
ImageConfig
IntegerTimePoint
Invitation
InvitationData
LatencyGraphResponse
LLMOptions
LocationBoundingBox
LocationPolygon
LocationRadius
LoginData
LogoutResponse
MatchCondition
Message
MessagesPerUserResponse
Metadata
MmrOptions
MultiQuery
NewChunkMetadataTypes
OpenGraphMetadata
Organization
OrganizationUsageCount
OrganizationWithSubAndPlan
PartnerConfiguration
Pdf2MdOptions
PopularChat
PopularChatsResponse
PopularFilters
PopularFiltersResponse
PostInvitationData
PostInvitationResponse
PublicDatasetOptions
PublicPageData
PublicPageParameters
PublicPageResponse
PublicPageSearchOptions
PublicPageTabMessage
PublicPageTag
PublicPageTheme
PurchaseItem
QdrantChunkMetadata
QdrantSortBy
QueryCountResponse
QueryRatingRange
QueryTypes
RAGAnalytics
RAGAnalyticsFilter
RAGAnalyticsResponse
RagQueryEvent
RagQueryRatingsResponse
RagQueryResponse
RAGSortBy
RagTypes
RAGUsageGraphResponse
RAGUsageResponse
Range
RangeCondition
RateQueryRequest
RecommendationAnalytics
RecommendationAnalyticsFilter
RecommendationAnalyticsResponse
RecommendationCTRMetrics
RecommendationEvent
RecommendationsConversionRateResponse
RecommendationsCTRRateResponse
RecommendationsEventResponse
RecommendationSortBy
RecommendationsPerUserResponse
RecommendationStrategy
RecommendationsWithClicksCTRResponse
RecommendationsWithoutClicksCTRResponse
RecommendationType
RecommendationUsageGraphResponse
RecommendChunksRequest
RecommendChunksResponseBody
RecommendGroupsReqPayload
RecommendGroupsResponse
RecommendGroupsResponseBody
RecommendResponseTypes
RecommendType
RegenerateMessageData
RegenerateMessagePatchData
RegenerateMessagePatchResponse
RegenerateMessageReqPayload
RegenerateMessageResponse
RemoveChunkFromGroupData
RemoveChunkFromGroupReqPayload
RemoveChunkFromGroupResponse
RequestInfo
ReRankOptions
ReturnQueuedChunk
RoleProxy
ScoreChunk
ScoreChunkDTO
ScoringOptions
ScrapeOptions
ScrollChunksReqPayload
ScrollChunksResponseBody
ScrollDatasetChunksData
ScrollDatasetChunksResponse
SearchAnalytics
SearchAnalyticsFilter
SearchAnalyticsResponse
SearchAverageRatingResponse
SearchChunkQueryResponseBody
SearchChunksData
SearchChunksReqPayload
SearchChunksResponse
SearchClusterResponse
SearchClusterTopics
SearchConversionRateResponse
SearchCTRMetrics
SearchesPerUserResponse
SearchGroupResponseTypes
SearchMethod
SearchModalities
SearchOverGroupsData
SearchOverGroupsReqPayload
SearchOverGroupsResponse
SearchOverGroupsResponseBody
SearchOverGroupsResponseTypes
SearchOverGroupsResults
SearchQueriesWithClicksCTRResponse
SearchQueriesWithoutClicksCTRResponse
SearchQueryEvent
SearchQueryRating
SearchQueryResponse
SearchResponseBody
SearchResponseTypes
SearchResultType
SearchRevenueResponse
SearchSortBy
SearchType
SearchTypeCount
SearchUsageGraphResponse
SearchWithinGroupData
SearchWithinGroupReqPayload
SearchWithinGroupResponse
SearchWithinGroupResponseBody
SearchWithinGroupResults
SemanticBoost
SendCtrDataData
SendCtrDataResponse
SendEventDataData
SendEventDataResponse
SetRagQueryRatingData
SetRagQueryRatingResponse
SetSearchQueryRatingData
SetSearchQueryRatingResponse
SingleProductOptions
SingleQueuedChunkResponse
Sitemap
SlimChunkMetadata
SlimChunkMetadataWithArrayTagSet
SlimChunkMetadataWithScore
SlimUser
SortByField
SortBySearchType
SortOptions
SortOrder
SplitHtmlContentData
SplitHtmlContentResponse
SplitHtmlResponse
StripeInvoice
StripePlan
StripeSubscription
StripeUsageBasedPlan
StripeUsageBasedSubscription
SuggestedQueriesReqPayload
SuggestedQueriesResponse
SuggestType
TagsWithCount
ToolFunction
ToolFunctionParameter
ToolFunctionParameterType
TopComponents
TopComponentsResponse
TopDatasetsRequestTypes
TopDatasetsResponse
Topic
TopicAnalyticsFilter
TopicAnalyticsSummary
TopicDetailsResponse
TopicQueriesResponse
TopicQuery
TopicsOverTimeResponse
TopPages
TopPagesResponse
TotalUniqueUsersResponse
TrievePlan
TrieveSubscription
type
type2
type3
type4
type5
type6
type7
type8
TypoOptions
TypoRange
UpdateAllOrgDatasetConfigsData
UpdateAllOrgDatasetConfigsReqPayload
UpdateAllOrgDatasetConfigsResponse
UpdateChunkByTrackingIdData
UpdateChunkByTrackingIdData2
UpdateChunkByTrackingIdResponse
UpdateChunkData
UpdateChunkGroupData
UpdateChunkGroupReqPayload
UpdateChunkGroupResponse
UpdateChunkReqPayload
UpdateChunkResponse
UpdateCrawlReqPayload
UpdateCrawlRequestData
UpdateCrawlRequestResponse
UpdateDatasetData
UpdateDatasetReqPayload
UpdateDatasetResponse
UpdateGroupByTrackingIDReqPayload
UpdateOrganizationData
UpdateOrganizationReqPayload
UpdateOrganizationResponse
UpdatePaymentMethodData
UpdatePaymentMethodResponse
UpdateSubscriptionPlanData
UpdateSubscriptionPlanResponse
UpdateTopicData
UpdateTopicReqPayload
UpdateTopicResponse
UpdateUserData
UpdateUserOrgRoleReqPayload
UpdateUserResponse
UploadFileHandlerData
UploadFileHandlerResponse
UploadFileReqPayload
UploadFileResponseBody
UploadHtmlPageData
UploadHtmlPageReqPayload
UploadHtmlPageResponse
UserApiKey
UserOrganization
V1RecommendChunksResponseBody
WorkerEvent
User Methods
updateUserRole
M
M
N
E
P
V
F
C
I
C
P
M
F
P
C
P
T
T
A
A
A
T
R