Update docs content

[amirhouieh]

We need to read through the documentation and look for

• Outdated content, examples, and snippet codes
• Mistakes and irrelevant content
• Missing content (e.g; Typescript examples)

[Aashish-Upadhyay-101]

const u = new Unbody({
  apiKey: "<API_KEY>",
  projectId: "<PROJECT_ID>",
});

I have to add the ! at the end of the keys. Is that expected behavior? or that could be changed in the SDK definition?

[Aashish-Upadhyay-101]

for semantic search:

example 1, 2 and 3 should have exec function and also must show how to destructure the data as something like this:

  const { data: { payload } } = await unbody.get.googleDoc.search.about("search_string").exec();

[Aashish-Upadhyay-101]

same for Keyword search example:

  const { data: { payload } } = await unbody.get.googleDoc.search.find("search_keyword").exec();

[Aashish-Upadhyay-101]

I feel like every code example should also include how you can destructure the output, and every query should have a exec function.

here as well in Semantic search > nearVector search

unbody.get
    .article
    .nearVector({
        vector: [...vector representing “web development”...],
        moveTo: {
            concepts: ["frontend", "backend"],
            force: 0.5
        }
    })
    .exec()

also

nearText and nearVector documentation needs to be updated because nearVector doesn't show any moveTo property.

and the vector property these searches has is very confusing, I don't know what it is trying to convey.

1. not sure what you mean by "destructure the output"
2. "vector" is a common concept and plz note these methods are quite advance and surely when a user is using "nearVector" they know what "vector" is. But in general I agree we can improve these parts but they have low propriety for time being!

[Aashish-Upadhyay-101]

SDK has not being updated:

can't perform *Record Similarity Search using SDK

unbody.get.googleDocs.search.similar("id", {...option})

[amirhouieh]

const u = new Unbody({
  apiKey: "<API_KEY>",
  projectId: "<PROJECT_ID>",
});

I have to add the ! at the end of the keys. Is that expected behavior? or that could be changed in the SDK definition?

I did not understand! could you add an example?

[amirhouieh]

SDK has not being updated:

can't perform *Record Similarity Search using SDK

unbody.get.googleDocs.search.similar("id", {...option})

@jeangovil

[jeangovil]

SDK has not being updated:

can't perform *Record Similarity Search using SDK

unbody.get.googleDocs.search.similar("id", {...option})

That's not the correct syntax, here's the correct way:

unbody.get.googleDoc.similar.record('id', {}).exec()

[Aashish-Upadhyay-101]

@jeangovil then It need to be updated in the docs because the docs has:

unbody.get
    .googleDoc
    .search
    .similar
    .record("specificDocId");

[Aashish-Upadhyay-101]

also in the Generative Search Example 1:

The exact same query as:

unbody.get
    .textBlock
    .generate
    .fromOne("Transform this historical fact into a captivating tweet: {content}")
    .exec()

throws a error as:

[
  {
    locations: [ [Object] ],
    message: 'explorer: list class: extend: extend generate: Prompt does not contain any properties. Use {PROPERTY_NAME} in the prompt to instuct Weaviate which data to use',       
    path: [ 'Get', 'GoogleDoc' ]
  },
  digest: '3288676927'
]

[Aashish-Upadhyay-101]

QnA Example 1:

The same query gives an error as:

[Aashish-Upadhyay-101]

List of Supported Argument:

includeMeta and orderBy is not in the SDK

[Aashish-Upadhyay-101]

No Aggregate Page

[Aashish-Upadhyay-101]

is filters available for javascript SDK?

[Aashish-Upadhyay-101]

does unbody JS-SDK has Image API support?

[amirhouieh]

does unbody JS-SDK has Image API support?

Nope and it does not need one

[amirhouieh]

is filters available for javascript SDK?

https://www.unbody.io/docs/libraries/typescript-client