Skip to main content

Search API

All URIs are relative to http://localhost:1000

MethodHTTP requestDescription
fullTextSearchGET /search/full_text/search/full_text [GET]
neuralCodeSearchGET /search/neural_code/search/neural_code [GET]
tagBasedSearchPOST /search/tag_based/search/tag_based [POST]

fullTextSearch

SearchedAssets fullTextSearch()

This will run FTS for exact search, and will NOT run fuzzy matching. This will only search the content within the

Example

import * as Pieces from '@pieces.app/pieces-os-client'

const configuration = Pieces.Configuration()
const apiInstance = new Pieces.SearchApi(configuration)

const body: Pieces.FullTextSearchRequest = {
// string | This is a string that you can use to search your assets. (optional)
query: query_example,
// boolean | This is helper boolean that will give you the ability to also include your pseudo assets, we will always default to false. (optional)
pseudo: true,
};

apiInstance.fullTextSearch(body).then((data: SearchedAssets) => {
console.log('API called successfully. Returned data: ' + data)
}).catch((error: unknown) => console.error(error))

Parameters

NameTypeDescriptionNotes
query[string]This is a string that you can use to search your assets.(optional) defaults to undefined
pseudo[boolean]This is helper boolean that will give you the ability to also include your pseudo assets, we will always default to false.(optional) defaults to undefined

Return type

SearchedAssets

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/plain

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-

neuralCodeSearch

SearchedAssets neuralCodeSearch()

This will run ncs on your assets. This will simply return FlattenedAssets, but will just be the assetuuids that match.

Example

import * as Pieces from '@pieces.app/pieces-os-client'

const configuration = Pieces.Configuration()
const apiInstance = new Pieces.SearchApi(configuration)

const body: Pieces.NeuralCodeSearchRequest = {
// string | This is a string that you can use to search your assets. (optional)
query: query_example,
// boolean | This is helper boolean that will give you the ability to also include your pseudo assets, we will always default to false. (optional)
pseudo: true,
};

apiInstance.neuralCodeSearch(body).then((data: SearchedAssets) => {
console.log('API called successfully. Returned data: ' + data)
}).catch((error: unknown) => console.error(error))

Parameters

NameTypeDescriptionNotes
query[string]This is a string that you can use to search your assets.(optional) defaults to undefined
pseudo[boolean]This is helper boolean that will give you the ability to also include your pseudo assets, we will always default to false.(optional) defaults to undefined

Return type

SearchedAssets

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/plain

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-

tagBasedSearch

SearchedAssets tagBasedSearch()

This will run our tag based search, and return the assets that best match your passed in tags. This will simply return FlattenedAssets, but will just be the assetuuids that match.

Example

import * as Pieces from '@pieces.app/pieces-os-client'

const configuration = Pieces.Configuration()
const apiInstance = new Pieces.SearchApi(configuration)

const body: Pieces.TagBasedSearchRequest = {
// boolean | This is helper boolean that will give you the ability to also include your pseudo assets, we will always default to false. (optional)
pseudo: true,
// SeededAssetTags (optional)
seededAssetTags: ,
};

apiInstance.tagBasedSearch(body).then((data: SearchedAssets) => {
console.log('API called successfully. Returned data: ' + data)
}).catch((error: unknown) => console.error(error))

Parameters

NameTypeDescriptionNotes
seededAssetTagsSeededAssetTags
pseudo[boolean]This is helper boolean that will give you the ability to also include your pseudo assets, we will always default to false.(optional) defaults to undefined

Return type

SearchedAssets

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, text/plain

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-