diff --git a/_includes/clients/ts-client-intro.mdx b/_includes/clients/ts-client-intro.mdx index 5bedc768..55ef1238 100644 --- a/_includes/clients/ts-client-intro.mdx +++ b/_includes/clients/ts-client-intro.mdx @@ -1,9 +1,9 @@ The TypeScript client supports code that is written in TypeScript or JavaScript. -The **v3 client** is the current TypeScript client. If you have code written for the v2 client, you should [migrate it to v3](/weaviate/client-libraries/typescript/v2_v3_migration) as the v2 client is no longer maintained. +The **v3 client** is the current TypeScript client. If you have code written for the v2 client, you should migrate it to v3 as the v2 client is no longer maintained. :::note -The v3 client supports server side development (Node.js hosted). If your application is browser based, you might consider using the [TypeScript client v2](/weaviate/client-libraries/typescript/typescript-v2). Keep in mind that the v2 client is outdated and no longer officially maintained. +The v3 client supports server side development (Node.js hosted). If your application is browser based, you might consider using the TypeScript client v2. Keep in mind that the v2 client is outdated and no longer officially maintained. ::: diff --git a/_includes/code/EMPTY.mdx b/_includes/code/EMPTY.mdx index da7b611b..22af5ccf 100644 --- a/_includes/code/EMPTY.mdx +++ b/_includes/code/EMPTY.mdx @@ -15,13 +15,6 @@ import TabItem from '@theme/TabItem'; ``` - - - -```js - -``` - diff --git a/_includes/code/configuration/replication-consistency.mdx b/_includes/code/configuration/replication-consistency.mdx index 1f442987..3052baab 100644 --- a/_includes/code/configuration/replication-consistency.mdx +++ b/_includes/code/configuration/replication-consistency.mdx @@ -2,7 +2,6 @@ import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; import PyCode from '!!raw-loader!/_includes/code/howto/manage-data.collections.py'; import TSCode from '!!raw-loader!/_includes/code/howto/manage-data.collections.ts'; -import TSCodeLegacy from '!!raw-loader!/_includes/code/howto/manage-data.collections-v2.ts'; import FilteredTextBlock from '@site/src/components/Documentation/FilteredTextBlock'; @@ -17,7 +16,7 @@ import FilteredTextBlock from '@site/src/components/Documentation/FilteredTextBl - + - - - ```bash diff --git a/_includes/code/connections/oidc-connect.mdx b/_includes/code/connections/oidc-connect.mdx index 83a4721b..82624c85 100644 --- a/_includes/code/connections/oidc-connect.mdx +++ b/_includes/code/connections/oidc-connect.mdx @@ -18,7 +18,7 @@ import GoCode from '!!raw-loader!/_includes/code/connections/connect.go'; language="py" /> - + - - - - + - + - + - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'http', - host: 'localhost:8080', -}); - -const response = await client.c11y - .extensionCreator() - .withConcept('weaviate') - .withDefinition('Open source cloud native real time vector database') - .withWeight(1) - .do(); -console.log(JSON.stringify(response, null, 2)); -``` - diff --git a/_includes/code/contextionary.get.mdx b/_includes/code/contextionary.get.mdx index 4506e400..8d8b35a0 100644 --- a/_includes/code/contextionary.get.mdx +++ b/_includes/code/contextionary.get.mdx @@ -13,24 +13,6 @@ concept_info = client.contextionary.get_concept_vector("fashionMagazine") print(concept_info) ``` - - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'http', - host: 'localhost:8080', -}); - -const response = await client.c11y - .conceptsGetter() - .withConcept('fashionMagazine') - .do(); -console.log(JSON.stringify(response, null, 2)); -``` - diff --git a/_includes/code/core.client.openai.apikey.mdx b/_includes/code/core.client.openai.apikey.mdx index 4a9dde64..38c7cf62 100644 --- a/_includes/code/core.client.openai.apikey.mdx +++ b/_includes/code/core.client.openai.apikey.mdx @@ -18,25 +18,6 @@ client = weaviate.Client( ) ``` - - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'https', - host: 'WEAVIATE_INSTANCE_URL', - // highlight-start - // Replace with your API key - headers: { - 'X-OpenAI-Api-Key': 'YOUR-OPENAI-API-KEY', - 'X-Azure-Api-Key': 'YOUR-AZURE-API-KEY', - }, - // highlight-end -}); -``` - diff --git a/_includes/code/embedded.instantiate.custom.mdx b/_includes/code/embedded.instantiate.custom.mdx index 091facae..66e786a5 100644 --- a/_includes/code/embedded.instantiate.custom.mdx +++ b/_includes/code/embedded.instantiate.custom.mdx @@ -14,12 +14,4 @@ import TsCodeV2CustomModules from '!!raw-loader!/_includes/code/install/embedded language="py" /> - - - diff --git a/_includes/code/embedded.instantiate.mdx b/_includes/code/embedded.instantiate.mdx index 47f76c9e..867458b1 100644 --- a/_includes/code/embedded.instantiate.mdx +++ b/_includes/code/embedded.instantiate.mdx @@ -13,12 +13,4 @@ import TsCodeV2 from '!!raw-loader!/_includes/code/install/embedded-v2.ts'; language="py" /> - - - diff --git a/_includes/code/embedded.instantiate.module.mdx b/_includes/code/embedded.instantiate.module.mdx index 4c9eda7c..e9fa03ee 100644 --- a/_includes/code/embedded.instantiate.module.mdx +++ b/_includes/code/embedded.instantiate.module.mdx @@ -14,12 +14,4 @@ import TsCodeV2CustomModules from '!!raw-loader!/_includes/code/install/embedded language="py" /> - - - diff --git a/_includes/code/embedded.instantiate.simple.mdx b/_includes/code/embedded.instantiate.simple.mdx index 1d94f27b..10d4f89f 100644 --- a/_includes/code/embedded.instantiate.simple.mdx +++ b/_includes/code/embedded.instantiate.simple.mdx @@ -14,7 +14,7 @@ import PyCode from '!!raw-loader!/_includes/code/tutorials/connect.py'; - + ```js // Coming soon @@ -22,19 +22,4 @@ import PyCode from '!!raw-loader!/_includes/code/tutorials/connect.py'; - - - ```js - import weaviate, { EmbeddedOptions } from 'weaviate-ts-embedded'; - - const client = weaviate.client(new EmbeddedOptions()); - - await client.embedded.start(); - - // Work with Weaviate - - client.embedded.stop(); - ``` - - diff --git a/_includes/code/generative.anyscale.groupedresult.mdx b/_includes/code/generative.anyscale.groupedresult.mdx index edfe9796..a1f7d099 100644 --- a/_includes/code/generative.anyscale.groupedresult.mdx +++ b/_includes/code/generative.anyscale.groupedresult.mdx @@ -65,39 +65,6 @@ result = ( print(result) ``` - - - -```ts -import weaviate, { ApiKey } from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'https', - host: 'edu-demo.weaviate.network', - apiKey: new ApiKey('learn-weaviate'), - headers: { 'X-Anyscale-Api-Key': process.env['ANYSCALE_API_KEY'] }, -}); - -// highlight-start -// instruction for the generative module -const generateTask = 'Please answer the question: What is ref2vec? based on the following search results. IMPORTANT! Please make sure your answer is supported by the information in the search results and provide references to the provided content when possible.'; -// highlight-end - -const response = await client.graphql - .get() - .withClassName('PodClip') - .withFields('speaker content') - .withNearText({ - concepts: ['What is ref2vec?'], - }) - .withGenerate({ - groupedTask: generateTask, - }) - .withLimit(5) - .do(); -console.log(JSON.stringify(response, null, 2)); -``` - diff --git a/_includes/code/generative.anyscale.singleresult.mdx b/_includes/code/generative.anyscale.singleresult.mdx index fa941676..7c74852d 100644 --- a/_includes/code/generative.anyscale.singleresult.mdx +++ b/_includes/code/generative.anyscale.singleresult.mdx @@ -58,36 +58,6 @@ result = ( print(result) ``` - - - -```ts -import weaviate, { ApiKey } from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'https', - host: 'edu-demo.weaviate.network', - apiKey: new ApiKey('learn-weaviate'), - headers: { 'X-Anyscale-Api-Key': process.env['ANYSCALE_API_KEY'] }, -}); - -// highlight-start -// instruction for the generative module -const generatePrompt = 'Please summarize the following podcast clip into one sentence. Speaker: {speaker} said {content}.'; -// highlight-end - -const response = await client.graphql - .get() - .withClassName('PodClip') - .withFields('speaker content') - .withGenerate({ - singlePrompt: generatePrompt, - }) - .withLimit(1) - .do(); -console.log(JSON.stringify(response, null, 2)); -``` - diff --git a/_includes/code/generative.aws.groupedresult.mdx b/_includes/code/generative.aws.groupedresult.mdx index 13bf8170..efb472b8 100644 --- a/_includes/code/generative.aws.groupedresult.mdx +++ b/_includes/code/generative.aws.groupedresult.mdx @@ -11,42 +11,6 @@ import FilteredTextBlock from '@site/src/components/Documentation/FilteredTextBl endMarker="# END GenerativeAWS" language="py" /> - - - -```ts -import weaviate, { ApiKey } from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'https', - host: 'edu-demo.weaviate.network', - apiKey: new ApiKey('learn-weaviate'), - headers: { - 'X-AWS-Access-Key': 'YOUR_ACCESS_KEY', - 'X-AWS-Secret-Key': 'YOUR_SECRET_KEY' - }, -}); - -// highlight-start -// instruction for the generative module -const generateTask = 'Explain why these magazines or newspapers are about finance'; -// highlight-end - -const response = await client.graphql - .get() - .withClassName('Article') - .withFields('title') - .withNearText({ - concepts: ['magazine or newspaper about finance'], - }) - .withGenerate({ - groupedTask: generateTask, - }) - .withLimit(5) - .do(); -console.log(JSON.stringify(response, null, 2)); -``` - diff --git a/_includes/code/generative.aws.singleresult.mdx b/_includes/code/generative.aws.singleresult.mdx index 78db444c..1f0e123b 100644 --- a/_includes/code/generative.aws.singleresult.mdx +++ b/_includes/code/generative.aws.singleresult.mdx @@ -11,42 +11,6 @@ import FilteredTextBlock from '@site/src/components/Documentation/FilteredTextBl endMarker="# END GenerativeAWS" language="py" /> - - - -```ts -import weaviate, { ApiKey } from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'https', - host: 'edu-demo.weaviate.network', - apiKey: new ApiKey('learn-weaviate'), - headers: { - 'X-AWS-Access-Key': 'YOUR_ACCESS_KEY', - 'X-AWS-Secret-Key': 'YOUR_SECRET_KEY' - }, -}); - -// highlight-start -// instruction for the generative module -const generatePrompt = 'Describe the following as a Facebook Ad: {summary}'; -// highlight-end - -const response = await client.graphql - .get() - .withClassName('Article') - .withFields('title summary') - .withNearText({ - concepts: ['Italian food'], - }) - .withGenerate({ - singlePrompt: generatePrompt, - }) - .withLimit(5) - .do(); -console.log(JSON.stringify(response, null, 2)); -``` - diff --git a/_includes/code/generative.cohere.groupedresult.mdx b/_includes/code/generative.cohere.groupedresult.mdx index 64e2932a..5c2316d8 100644 --- a/_includes/code/generative.cohere.groupedresult.mdx +++ b/_includes/code/generative.cohere.groupedresult.mdx @@ -11,39 +11,6 @@ import FilteredTextBlock from '@site/src/components/Documentation/FilteredTextBl endMarker="# END GenerativeCohere" language="py" /> - - - -```ts -import weaviate, { ApiKey } from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'https', - host: 'edu-demo.weaviate.network', - apiKey: new ApiKey('learn-weaviate'), - headers: { 'X-Cohere-Api-Key': process.env['COHERE_API_KEY'] }, -}); - -// highlight-start -// instruction for the generative module -const generateTask = 'Explain why these magazines or newspapers are about finance'; -// highlight-end - -const response = await client.graphql - .get() - .withClassName('Article') - .withFields('title') - .withNearText({ - concepts: ['magazine or newspaper about finance'], - }) - .withGenerate({ - groupedTask: generateTask, - }) - .withLimit(5) - .do(); -console.log(JSON.stringify(response, null, 2)); -``` - diff --git a/_includes/code/generative.cohere.singleresult.mdx b/_includes/code/generative.cohere.singleresult.mdx index 47c99ea6..83a58eb6 100644 --- a/_includes/code/generative.cohere.singleresult.mdx +++ b/_includes/code/generative.cohere.singleresult.mdx @@ -11,39 +11,6 @@ import FilteredTextBlock from '@site/src/components/Documentation/FilteredTextBl endMarker="# END GenerativeCohere" language="py" /> - - - -```ts -import weaviate, { ApiKey } from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'https', - host: 'edu-demo.weaviate.network', - apiKey: new ApiKey('learn-weaviate'), - headers: { 'X-Cohere-Api-Key': process.env['COHERE_API_KEY'] }, -}); - -// highlight-start -// instruction for the generative module -const generatePrompt = 'Describe the following as a Facebook Ad: {summary}'; -// highlight-end - -const response = await client.graphql - .get() - .withClassName('Article') - .withFields('title summary') - .withNearText({ - concepts: ['Italian food'], - }) - .withGenerate({ - singlePrompt: generatePrompt, - }) - .withLimit(5) - .do(); -console.log(JSON.stringify(response, null, 2)); -``` - diff --git a/_includes/code/generative.local.groupedresult.mdx b/_includes/code/generative.local.groupedresult.mdx index 8d81cbad..bc095067 100644 --- a/_includes/code/generative.local.groupedresult.mdx +++ b/_includes/code/generative.local.groupedresult.mdx @@ -62,38 +62,6 @@ result = ( print(result) ``` - - - -```ts -import weaviate, { ApiKey } from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'https', - host: 'edu-demo.weaviate.network', - apiKey: new ApiKey('learn-weaviate'), -}); - -// highlight-start -// instruction for the generative module -const generateTask = 'Please answer the question: What is ref2vec? based on the following search results. IMPORTANT! Please make sure your answer is supported by the information in the search results and provide references to the provided content when possible.'; -// highlight-end - -const response = await client.graphql - .get() - .withClassName('PodClip') - .withFields('speaker content') - .withNearText({ - concepts: ['What is ref2vec?'], - }) - .withGenerate({ - groupedTask: generateTask, - }) - .withLimit(5) - .do(); -console.log(JSON.stringify(response, null, 2)); -``` - diff --git a/_includes/code/generative.local.singleresult.mdx b/_includes/code/generative.local.singleresult.mdx index 5a58dd4d..af6caeed 100644 --- a/_includes/code/generative.local.singleresult.mdx +++ b/_includes/code/generative.local.singleresult.mdx @@ -55,35 +55,6 @@ result = ( print(result) ``` - - - -```ts -import weaviate, { ApiKey } from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'https', - host: 'edu-demo.weaviate.network', - apiKey: new ApiKey('learn-weaviate'), -}); - -// highlight-start -// instruction for the generative module -const generatePrompt = 'Please summarize the following podcast clip into one sentence. Speaker: {speaker} said {content}.'; -// highlight-end - -const response = await client.graphql - .get() - .withClassName('PodClip') - .withFields('speaker content') - .withGenerate({ - singlePrompt: generatePrompt, - }) - .withLimit(1) - .do(); -console.log(JSON.stringify(response, null, 2)); -``` - diff --git a/_includes/code/generative.mistral.groupedresult.mdx b/_includes/code/generative.mistral.groupedresult.mdx index 2526efad..8c264ca0 100644 --- a/_includes/code/generative.mistral.groupedresult.mdx +++ b/_includes/code/generative.mistral.groupedresult.mdx @@ -65,39 +65,6 @@ result = ( print(result) ``` - - - -```ts -import weaviate, { ApiKey } from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'https', - host: 'edu-demo.weaviate.network', - apiKey: new ApiKey('learn-weaviate'), - headers: { 'X-Mistral-Api-Key': process.env['MISTRAL_API_KEY'] }, -}); - -// highlight-start -// instruction for the generative module -const generateTask = 'Please answer the question: What is ref2vec? based on the following search results. IMPORTANT! Please make sure your answer is supported by the information in the search results and provide references to the provided content when possible.'; -// highlight-end - -const response = await client.graphql - .get() - .withClassName('PodClip') - .withFields('speaker content') - .withNearText({ - concepts: ['What is ref2vec?'], - }) - .withGenerate({ - groupedTask: generateTask, - }) - .withLimit(5) - .do(); -console.log(JSON.stringify(response, null, 2)); -``` - diff --git a/_includes/code/generative.mistral.singleresult.mdx b/_includes/code/generative.mistral.singleresult.mdx index 87daa055..5b7e65f2 100644 --- a/_includes/code/generative.mistral.singleresult.mdx +++ b/_includes/code/generative.mistral.singleresult.mdx @@ -58,36 +58,6 @@ result = ( print(result) ``` - - - -```ts -import weaviate, { ApiKey } from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'https', - host: 'edu-demo.weaviate.network', - apiKey: new ApiKey('learn-weaviate'), - headers: { 'X-Mistral-Api-Key': process.env['MISTRAL_API_KEY'] }, -}); - -// highlight-start -// instruction for the generative module -const generatePrompt = 'Please summarize the following podcast clip into one sentence. Speaker: {speaker} said {content}.'; -// highlight-end - -const response = await client.graphql - .get() - .withClassName('PodClip') - .withFields('speaker content') - .withGenerate({ - singlePrompt: generatePrompt, - }) - .withLimit(1) - .do(); -console.log(JSON.stringify(response, null, 2)); -``` - diff --git a/_includes/code/generative.openai.groupedresult.mdx b/_includes/code/generative.openai.groupedresult.mdx index 59df6024..24409cf0 100644 --- a/_includes/code/generative.openai.groupedresult.mdx +++ b/_includes/code/generative.openai.groupedresult.mdx @@ -11,39 +11,6 @@ import FilteredTextBlock from '@site/src/components/Documentation/FilteredTextBl endMarker="# END GenerativeOpenAI" language="py" /> - - - -```ts -import weaviate, { ApiKey } from 'weaviate-ts-client'; - -const client= weaviate.client({ - scheme: 'https', - host: 'edu-demo.weaviate.network', - apiKey: new ApiKey('learn-weaviate'), - headers: { 'X-OpenAI-Api-Key': process.env['OPENAI_API_KEY'] }, -}); - -// highlight-start -// instruction for the generative module -const generateTask = 'Explain why these magazines or newspapers are about finance'; -// highlight-end - -const response = await client.graphql - .get() - .withClassName('Article') - .withFields('title') - .withNearText({ - concepts: ['magazine or newspaper about finance'], - }) - .withGenerate({ - groupedTask: generateTask, - }) - .withLimit(5) - .do(); -console.log(JSON.stringify(response, null, 2)); -``` - diff --git a/_includes/code/generative.openai.singleresult.mdx b/_includes/code/generative.openai.singleresult.mdx index abae8ebc..8845cd97 100644 --- a/_includes/code/generative.openai.singleresult.mdx +++ b/_includes/code/generative.openai.singleresult.mdx @@ -11,39 +11,6 @@ import FilteredTextBlock from '@site/src/components/Documentation/FilteredTextBl endMarker="# END GenerativeOpenAI" language="py" /> - - - -```js -import weaviate, { ApiKey } from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'https', - host: 'edu-demo.weaviate.network', - apiKey: new ApiKey('learn-weaviate'), - headers: { 'X-OpenAI-Api-Key': process.env['OPENAI_API_KEY'] }, // Replace with your API key -}); - -// highlight-start -// instruction for the generative module -const generatePrompt = 'Describe the following as a Facebook Ad: {summary}'; -// highlight-end - -const response = await client.graphql - .get() - .withClassName('Article') - .withFields('title summary') - .withNearText({ - concepts: ['Italian food'], - }) - .withGenerate({ - singlePrompt: generatePrompt, - }) - .withLimit(5) - .do(); -console.log(JSON.stringify(response, null, 2)); -``` - diff --git a/_includes/code/generative.palm.groupedresult.mdx b/_includes/code/generative.palm.groupedresult.mdx index c57465de..de168e08 100644 --- a/_includes/code/generative.palm.groupedresult.mdx +++ b/_includes/code/generative.palm.groupedresult.mdx @@ -11,39 +11,6 @@ import FilteredTextBlock from '@site/src/components/Documentation/FilteredTextBl endMarker="# END GenerativeGoogle" language="py" /> - - - -```ts -import weaviate, { ApiKey } from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'https', - host: 'WEAVIATE_INSTANCE_URL', // Replace with your Weaviate endpoint - apiKey: new ApiKey('YOUR-WEAVIATE-API-KEY'), // Replace with your Weaviate API key - headers: { 'X-PaLM-Api-Key': process.env['PALM_API_KEY'] }, // Replace with your GOOGLE API key -}); - -// highlight-start -// instruction for the generative module -const generateTask = 'Explain why these magazines or newspapers are about finance'; -// highlight-end - -const response = await client.graphql - .get() - .withClassName('Article') - .withFields('name') - .withNearText({ - concepts: ['magazine or newspaper about finance'], - }) - .withGenerate({ - groupedTask: generateTask, - }) - .withLimit(5) - .do(); -console.log(JSON.stringify(response, null, 2)); -``` - diff --git a/_includes/code/generative.palm.singleresult.mdx b/_includes/code/generative.palm.singleresult.mdx index 576d7d8b..80fef758 100644 --- a/_includes/code/generative.palm.singleresult.mdx +++ b/_includes/code/generative.palm.singleresult.mdx @@ -11,39 +11,6 @@ import FilteredTextBlock from '@site/src/components/Documentation/FilteredTextBl endMarker="# END GenerativeGoogle" language="py" /> - - - -```ts -import weaviate, { ApiKey } from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'https', - host: 'WEAVIATE_INSTANCE_URL', // Replace with your Weaviate endpoint - apiKey: new ApiKey('YOUR-WEAVIATE-API-KEY'), // Replace with your Weaviate API key - headers: { 'X-PaLM-Api-Key': process.env['PALM_API_KEY'] }, // Replace with your GOOGLE API key -}); - -// highlight-start -// instruction for the generative module -const generatePrompt = 'Describe the following as a Facebook Ad: {summary}'; -// highlight-end - -const response = await client.graphql - .get() - .withClassName('Article') - .withFields('title summary') - .withNearText({ - concepts: ['Italian food'], - }) - .withGenerate({ - singlePrompt: generatePrompt, - }) - .withLimit(5) - .do(); -console.log(JSON.stringify(response, null, 2)); -``` - diff --git a/_includes/code/graphql.aggregate.groupby.mdx b/_includes/code/graphql.aggregate.groupby.mdx index 3dde1fe0..2dfe83ae 100644 --- a/_includes/code/graphql.aggregate.groupby.mdx +++ b/_includes/code/graphql.aggregate.groupby.mdx @@ -12,26 +12,6 @@ import PyCode from '!!raw-loader!/_includes/code/graphql.aggregate.simple.py'; endMarker="END GraphQLSimpleAggregateGroupby" language="py" /> - - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'http', - host: 'localhost:8080', -}); - -const response = await client.graphql - .aggregate() - .withClassName('Article') - .withGroupBy(['inPublication']) - .withFields('meta { count } wordCount { mean } groupedBy { value path }') - .do(); -console.log(JSON.stringify(response, null, 2)); -``` - diff --git a/_includes/code/graphql.aggregate.nearObject.mdx b/_includes/code/graphql.aggregate.nearObject.mdx index 14aa9c72..311c6fe3 100644 --- a/_includes/code/graphql.aggregate.nearObject.mdx +++ b/_includes/code/graphql.aggregate.nearObject.mdx @@ -12,28 +12,6 @@ import PyCode from '!!raw-loader!/_includes/code/graphql.aggregate.simple.py'; endMarker="END GraphQLnearObjectAggregate" language="py" /> - - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'http', - host: 'localhost:8080', -}); - -const response = await client.graphql - .aggregate() - .withClassName('Article') - .withFields('meta { count } wordCount { count maximum mean median minimum mode sum type } inPublication { pointingTo type }') - // prior to v1.14, use certainty instead of distance - .withNearObject({ id: '00037775-1432-35e5-bc59-443baaef7d80', distance: 0.6 }) - .withObjectLimit(100) - .do(); -console.log(response); -``` - diff --git a/_includes/code/graphql.aggregate.nearText.mdx b/_includes/code/graphql.aggregate.nearText.mdx index 16a76f2f..d9005338 100644 --- a/_includes/code/graphql.aggregate.nearText.mdx +++ b/_includes/code/graphql.aggregate.nearText.mdx @@ -12,27 +12,6 @@ import PyCode from '!!raw-loader!/_includes/code/graphql.aggregate.simple.py'; endMarker="END GraphQLnearTextAggregate" language="py" /> - - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'http', - host: 'localhost:8080', -}); - -const response = await client.graphql - .aggregate() - .withClassName('Article') - .withFields('meta { count } wordCount {count maximum mean median minimum mode sum type}') - .withNearText({ concepts: ['apple iphone'], distance: 0.7 }) // prior to v1.14 use "certainty" instead of "distance" - .withObjectLimit(100) // at least one of "objectLimit", and/or "distance" must be set when using near media filters - .do(); -console.log(response); -``` - diff --git a/_includes/code/graphql.aggregate.nearVector.mdx b/_includes/code/graphql.aggregate.nearVector.mdx index 390ab70e..5662ed2d 100644 --- a/_includes/code/graphql.aggregate.nearVector.mdx +++ b/_includes/code/graphql.aggregate.nearVector.mdx @@ -12,27 +12,6 @@ import PyCode from '!!raw-loader!/_includes/code/graphql.aggregate.simple.py'; endMarker="END GraphQLnearVectorAggregate" language="py" /> - - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'http', - host: 'localhost:8080', -}); - -const response = await client.graphql - .aggregate() - .withClassName('Article') - .withFields('meta { count } wordCount {count maximum mean median minimum mode sum type}') - .withNearVector({ vector: [0.1, 0.2, -0.3], certainty: 0.7 }) - .withObjectLimit(100) - .do(); -console.log(response); -``` - diff --git a/_includes/code/graphql.aggregate.simple.mdx b/_includes/code/graphql.aggregate.simple.mdx index 41868ac3..d1bde921 100644 --- a/_includes/code/graphql.aggregate.simple.mdx +++ b/_includes/code/graphql.aggregate.simple.mdx @@ -12,25 +12,6 @@ import PyCode from '!!raw-loader!/_includes/code/graphql.aggregate.simple.py'; endMarker="END GraphQLAggregateSimple" language="py" /> - - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'http', - host: 'localhost:8080', -}); - -const response = await client.graphql - .aggregate() - .withClassName('Article') - .withFields('meta { count } wordCount {count maximum mean median minimum mode sum type}') - .do(); -console.log(response); -``` - diff --git a/_includes/code/graphql.explore.simple.mdx b/_includes/code/graphql.explore.simple.mdx index 27a1734a..ed3f7341 100644 --- a/_includes/code/graphql.explore.simple.mdx +++ b/_includes/code/graphql.explore.simple.mdx @@ -64,30 +64,6 @@ query_result = client.query.raw(explore_articles_query) print(query_result) ``` - - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'http', - host: 'localhost:8080', -}); - -const response = await client.graphql - .explore() - .withNearText({ - concepts: ['New Yorkers'], - moveTo: { concepts: ['publisher', 'articles'], force: 0.5 }, - moveAwayFrom: { concepts: ['fashion', 'shop'], force: 0.2 }, - distance: 0.95, // prior to v1.14, use certainty - }) - .withFields('beacon certainty distance className') // certainty is only supported if distance==cosine - .do(); -console.log(response); -``` - diff --git a/_includes/code/graphql.explore.vector.mdx b/_includes/code/graphql.explore.vector.mdx index 2c4db398..e1285853 100644 --- a/_includes/code/graphql.explore.vector.mdx +++ b/_includes/code/graphql.explore.vector.mdx @@ -2,25 +2,6 @@ import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'http', - host: 'localhost:8080', -}); - -const response = await client.graphql - .explore() - .withNearVector({ vector: [-0.36840257,0.13973749,-0.28994447,-0.18607682,0.20019795,0.15541431,-0.42353877,0.30262852,0.2724561,0.07069917,0.4877447,0.038771532,0.64523,-0.15907241,-0.3413626,-0.026682584,-0.63310874,-0.33411884,0.082939014,0.30305764,0.045918174,-0.21439327,-0.5005205,0.6210859,-0.2729049,-0.51221114,0.09680918,0.094923325,-0.15688285,-0.07325482,0.6588305,0.0523736,-0.14173415,-0.27428055,0.25526586,0.057506185,-0.3103442,0.028601522,0.124522656,0.66984487,0.12160647,-0.5090515,-0.540393,-0.39546522,-0.2201204,0.34625968,-0.21068871,0.21132985,0.048714135,0.09043683,0.3176081,-0.056684002,-0.12117501,-0.6591976,-0.26731065,0.42615625,0.33333477,-0.3240578,-0.18771006,0.2328068,-0.17239179,-0.33583146,-0.6556605,-0.10608161,-0.5135395,-0.25123677,-0.23004892,0.7036331,0.04456794,0.41253626,0.27872285,-0.28226635,0.11927197,-0.4677766,0.4343466,-0.17538455,0.10621233,0.95815116,0.23587844,-0.006406698,-0.10512518,-1.1125883,-0.37921682,0.040789194,0.676718,0.3369762,0.040712647,0.580487,0.20063736,-0.021220192,-0.09071747,-0.0023735985,0.30007777,-0.039925132,0.4035474,-0.2518212,-0.17846306,0.12371392,-0.0703354,-0.3752431,-0.652917,0.5952828,1.3426708,-0.08167235,-0.38515738,0.058423538,-0.08100355,-0.192886,0.3745164,-0.23291737,0.33326542,-0.6019264,-0.42822492,-0.6524583,-0.15210791,-0.5073593,0.022548754,-0.058033653,-0.47369233,-0.30890635,0.6338296,0.0017854869,0.1954949,0.99348027,-0.26558784,-0.058124136,1.149388,0.02915948,0.013422121,0.25484946,-0.030017598,-0.23879935,0.053123385,-0.36463016,-0.0024245526,0.1202083,-0.45966506,-0.34140104,-0.08484162,-0.03537422,-0.2817959,0.25044164,-0.5060605,0.1252808,-0.032539487,0.110069446,-0.20679846,-0.46421885,-0.4141739,0.26994973,-0.070687145,0.16862138,-0.20162229,0.22199251,-0.2771402,0.23653336,0.16585203,-0.08286354,-0.15343396,0.23893964,-0.7453282,-0.16549355,-0.1947069,0.46136436,0.22064126,0.28654936,-0.038697664,0.037633028,-0.80988157,0.5094175,-0.0920082,0.25405347,-0.64169943,0.43366328,-0.2999211,-0.4090591,0.11957859,0.00803617,-0.0433745,0.12818244,0.28464508,-0.31760025,0.16558012,-0.33553946,-0.3943465,0.59569097,-0.6524206,0.3683173,-0.60456693,0.2046492,0.46010277,0.24695799,0.2946015,0.11376746,-0.027988048,0.03749422,-0.16577742,0.23407385,-0.0231737,-0.023245076,0.08752677,0.2299883,0.35467404,0.046193745,-0.39828986,0.21079691,0.38396686,-0.0018698421,0.16047359,-0.057517264,-0.203534,0.23438136,-0.84250915,0.22371331,0.0058325706,0.30733636,0.19518353,-0.108008966,0.6509316,0.070131645,-0.24023099,0.28779706,0.2326336,0.07004021,-0.45955566,0.20426086,-0.37472793,-0.049604423,0.4537271,0.6133582,-1.0527759,-0.5472505,0.15193434,0.5296606,-0.11560251,0.07279209,0.40557706,0.2505283,0.24490519,0.017602902,-0.004647707,0.16608049,0.12576887,0.118216865,0.4403996,0.39552462,-0.22196701,-0.061155193,0.03693534,-0.4022908,0.3842317,-0.0831345,0.01930883,0.3446575,-0.2167439,-0.23994556,-0.09370326,-0.3671856,0.044011243,0.017895095,-0.019855855,-0.16416992,0.17858285,0.31287143,0.38368022,-0.006513525,0.45780763,-0.23027879,0.108570844,-0.4449492,-0.035763215,0.03818417,0.040017277,-0.17022872,-0.2622464,0.65610534,0.16720143,0.2515769,-0.23535803,0.62484455,0.16771325,-0.62404263,0.19176348,-0.72786695,0.18485649,-0.30914405,-0.3230534,-0.24064465,0.28841522,0.39792386,0.15618932,0.03928854,0.18277727,-0.101632096,0.1868196,-0.33366352,0.086561844,0.48557812,-0.6198209,-0.07978742]}) - .withFields('beacon certainty className') - .do(); -console.log(response); -``` - - ```go diff --git a/_includes/code/graphql.filters.after.mdx b/_includes/code/graphql.filters.after.mdx index 8b96b540..33ddd596 100644 --- a/_includes/code/graphql.filters.after.mdx +++ b/_includes/code/graphql.filters.after.mdx @@ -12,20 +12,6 @@ import PyCode from '!!raw-loader!/_includes/code/graphql.additional.py'; language="py" /> - - -```js -const response = await client.graphql - .get() - .withClassName('Article') - .withFields('title _additional { id }') - .withAfter('002d5cb3-298b-380d-addb-2e026b76c8ed') - .withLimit(5) - .do(); -console.log(JSON.stringify(response, null, 2)); -``` - - ```graphql diff --git a/_includes/code/graphql.filters.bm25.filter.example.mdx b/_includes/code/graphql.filters.bm25.filter.example.mdx index 306c0c23..06e7758f 100644 --- a/_includes/code/graphql.filters.bm25.filter.example.mdx +++ b/_includes/code/graphql.filters.bm25.filter.example.mdx @@ -12,28 +12,6 @@ import PyCode from '!!raw-loader!/_includes/code/graphql.search-operators.py'; endMarker="END GraphQLBM25WithFilter" language="py" /> - - - -```js -const response = await client.graphql - .get() - .withClassName('Article') - .withFields('title summary') - .withBm25({ - query: 'how to fish', - }) - // highlight-start - .withWhere({ - operator: 'LessThan', - path: ['wordCount'], - valueInt: 1000, - }) - // highlight-end - .do(); -console.log(JSON.stringify(response, null, 2)); -``` - diff --git a/_includes/code/graphql.filters.bm25.mdx b/_includes/code/graphql.filters.bm25.mdx index dde327db..d2f32b19 100644 --- a/_includes/code/graphql.filters.bm25.mdx +++ b/_includes/code/graphql.filters.bm25.mdx @@ -12,29 +12,6 @@ import PyCode from '!!raw-loader!/_includes/code/graphql.search-operators.py'; endMarker="END GraphQLBM25Basic" language="py" /> - - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'http', - host: 'localhost:8080', -}); - -const response = await client.graphql - .get() - .withClassName('Article') - .withFields('title _additional {score}') - .withBm25({ - query: 'fox', - properties: ['title'], - }) - .do(); -console.log(response); -``` - diff --git a/_includes/code/graphql.filters.group.mdx b/_includes/code/graphql.filters.group.mdx index 7e82eb4c..1b1aeb2b 100644 --- a/_includes/code/graphql.filters.group.mdx +++ b/_includes/code/graphql.filters.group.mdx @@ -12,29 +12,6 @@ import PyCode from '!!raw-loader!/_includes/code/graphql.additional.py'; language="py" /> - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'http', - host: 'localhost:8080', -}); - -const response = await client.graphql - .get() - .withClassName('Publication') - .withFields('name') - .withGroup({ - type: 'merge', - force: 0.05, - }) - .do(); -console.log(response); -``` - - ```go diff --git a/_includes/code/graphql.filters.hybrid.filter.example.mdx b/_includes/code/graphql.filters.hybrid.filter.example.mdx index b6f54067..f13fec40 100644 --- a/_includes/code/graphql.filters.hybrid.filter.example.mdx +++ b/_includes/code/graphql.filters.hybrid.filter.example.mdx @@ -12,29 +12,6 @@ import PyCode from '!!raw-loader!/_includes/code/graphql.search-operators.py'; endMarker="END GraphQLHybridWithFilter" language="py" /> - - - -```js -const response = await client.graphql - .get() - .withClassName('Article') - .withFields('title summary') - .withHybrid({ - query: 'How to catch Alaskan Pollock', - alpha: 0.5, - }) - // highlight-start - .withWhere({ - operator: 'LessThan', - path: ['wordCount'], - valueInt: 1000, - }) - // highlight-end - .do(); -console.log(JSON.stringify(response, null, 2)); -``` - diff --git a/_includes/code/graphql.filters.hybrid.mdx b/_includes/code/graphql.filters.hybrid.mdx index 9a9bbd14..89812109 100644 --- a/_includes/code/graphql.filters.hybrid.mdx +++ b/_includes/code/graphql.filters.hybrid.mdx @@ -12,22 +12,6 @@ import PyCode from '!!raw-loader!/_includes/code/graphql.search-operators.py'; endMarker="END GraphQLHybridSearch" language="py" /> - - - -```js -const response = await client.graphql - .get() - .withClassName('Article') - .withFields('title summary _additional { score explainScore }') - .withHybrid({ - query: 'Fisherman that catches salmon', - alpha: 0.5, // optional, defaults to 0.75 - }) - .do(); -console.log(JSON.stringify(response, null, 2)); -``` - diff --git a/_includes/code/graphql.filters.hybrid.properties.mdx b/_includes/code/graphql.filters.hybrid.properties.mdx index 48e398c1..ace638b5 100644 --- a/_includes/code/graphql.filters.hybrid.properties.mdx +++ b/_includes/code/graphql.filters.hybrid.properties.mdx @@ -14,27 +14,6 @@ import PyCode from '!!raw-loader!/_includes/code/graphql.search-operators.py'; endMarker="END GraphQLHybridWithPropertiesSpecified" language="py" /> - - - -```js -const response = await client.graphql - .get() - .withClassName('JeopardyQuestion') - .withFields('question answer _additional{ score }') - .withHybrid({ - query: 'Venus', - alpha: 0.25, // closer to pure keyword search -// highlight-start - properties: ['question'], // changing to "answer" will yield a different set of results -// highlight-end - }) - withLimit(3) - .do(); - -console.log(response['data']['Get']['JeopardyQuestion']); -``` - diff --git a/_includes/code/graphql.filters.hybrid.vector.mdx b/_includes/code/graphql.filters.hybrid.vector.mdx index 0ee014b8..8663f252 100644 --- a/_includes/code/graphql.filters.hybrid.vector.mdx +++ b/_includes/code/graphql.filters.hybrid.vector.mdx @@ -12,23 +12,6 @@ import PyCode from '!!raw-loader!/_includes/code/graphql.search-operators.py'; endMarker="END GraphQLHybridWithVector" language="py" /> - - - -```js -const response = await client.graphql - .get() - .withClassName('Article') - .withFields('title summary _additional { score }') - .withHybrid({ - query: 'Fisherman that catches salmon', - vector: [1, 2, 3], // optional. Not needed if Weaviate handles the vectorization. - alpha: 0.5, // optional, defaults to 0.75 - }) - .do(); -console.log(response); -``` - diff --git a/_includes/code/graphql.filters.limit.mdx b/_includes/code/graphql.filters.limit.mdx index 69475e30..33b70d7c 100644 --- a/_includes/code/graphql.filters.limit.mdx +++ b/_includes/code/graphql.filters.limit.mdx @@ -12,26 +12,6 @@ import PyCode from '!!raw-loader!/_includes/code/graphql.additional.py'; language="py" /> - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'http', - host: 'localhost:8080', -}); - -const response = await client.graphql - .get() - .withClassName('Article') - .withFields('title') - .withLimit(5) - .do(); -console.log(response); -``` - - ```go diff --git a/_includes/code/graphql.filters.nearObject.mdx b/_includes/code/graphql.filters.nearObject.mdx index 66a8a098..a9ed59e2 100644 --- a/_includes/code/graphql.filters.nearObject.mdx +++ b/_includes/code/graphql.filters.nearObject.mdx @@ -12,30 +12,6 @@ import PyCode from '!!raw-loader!/_includes/code/graphql.search-operators.py'; endMarker="END GraphQLnearObject" language="py" /> - - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'http', - host: 'localhost:8080', -}); - -const response = await client.graphql - .get() - .withClassName('Publication') - .withFields('name _additional {certainty distance}}') // certainty only supported if distance==cosine - .withNearObject({ - id: '32d5a368-ace8-3bb7-ade7-9f7ff03eddb6', - distance: 0.6, - }) - .withLimit(5) - .do(); -console.log(response); -``` - diff --git a/_includes/code/graphql.filters.nearText.2obj.mdx b/_includes/code/graphql.filters.nearText.2obj.mdx index 0e26f2e2..e019610e 100644 --- a/_includes/code/graphql.filters.nearText.2obj.mdx +++ b/_includes/code/graphql.filters.nearText.2obj.mdx @@ -12,34 +12,6 @@ import PyCode from '!!raw-loader!/_includes/code/graphql.search-operators.py'; endMarker="END GraphQLnearText2" language="py" /> - - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'http', - host: 'localhost:8080', -}); - -const response = await client.graphql - .get() - .withClassName('Article') - .withFields('title summary _additional { certainty }') - .withNearText({ - concepts: ['travelling in Asia'], - certainty: 0.7, - moveTo: { - // this ID is of the article: "Tohoku: A Japan destination for all seasons." - objects: [{ id: 'c4209549-7981-3699-9648-61a78c2124b9' }], - force: 0.85, - }, - }) - .do(); -console.log(response); -``` - diff --git a/_includes/code/graphql.filters.nearText.aws.mdx b/_includes/code/graphql.filters.nearText.aws.mdx index 150fb30f..a572329f 100644 --- a/_includes/code/graphql.filters.nearText.aws.mdx +++ b/_includes/code/graphql.filters.nearText.aws.mdx @@ -13,42 +13,6 @@ import FilteredTextBlock from '@site/src/components/Documentation/FilteredTextBl /> - - -```js -import weaviate, { ApiKey } from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'https', - host: 'WEAVIATE_INSTANCE_URL', // Replace WEAVIATE_INSTANCE_URL with your instance URL - apiKey: new ApiKey('YOUR-API-KEY'), - headers: { - 'X-AWS-Access-Key': 'YOUR_ACCESS_KEY', - 'X-AWS-Secret-Key': 'YOUR_SECRET_KEY' - }, -}); - -const response = await client.graphql - .get() - .withClassName('Publication') - .withFields('name _additional{certainty distance}') // note that certainty is only supported if distance==cosine - .withNearText({ - concepts: ['fashion'], - distance: 0.6, // prior to v1.14 use certainty instead of distance - moveAwayFrom: { - concepts: ['finance'], - force: 0.45, - }, - moveTo: { - concepts: ['haute couture'], - force: 0.85, - }, - }) - .do(); -console.log(response); -``` - - ```go diff --git a/_includes/code/graphql.filters.nearText.cohere.mdx b/_includes/code/graphql.filters.nearText.cohere.mdx index 1820fe8f..69b3fb23 100644 --- a/_includes/code/graphql.filters.nearText.cohere.mdx +++ b/_includes/code/graphql.filters.nearText.cohere.mdx @@ -11,38 +11,6 @@ import FilteredTextBlock from '@site/src/components/Documentation/FilteredTextBl endMarker="# END NearTextCohere" language="py" /> - - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'http', - host: 'localhost:8080', - headers: { 'X-Cohere-Api-Key': 'YOUR-COHERE-API-KEY' }, -}); - -const response = await client.graphql - .get() - .withClassName('Publication') - .withFields('name _additional{certainty distance}') // note that certainty is only supported if distance==cosine - .withNearText({ - concepts: ['fashion'], - distance: 0.6, // prior to v1.14 use certainty instead of distance - moveAwayFrom: { - concepts: ['finance'], - force: 0.45, - }, - moveTo: { - concepts: ['haute couture'], - force: 0.85, - }, - }) - .do(); -console.log(response); -``` - diff --git a/_includes/code/graphql.filters.nearText.huggingface.mdx b/_includes/code/graphql.filters.nearText.huggingface.mdx index e768cc76..68bb0401 100644 --- a/_includes/code/graphql.filters.nearText.huggingface.mdx +++ b/_includes/code/graphql.filters.nearText.huggingface.mdx @@ -11,38 +11,6 @@ import FilteredTextBlock from '@site/src/components/Documentation/FilteredTextBl endMarker="# END NearTextHuggingface" language="py" /> - - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'http', - host: 'localhost:8080', - headers: { 'X-HuggingFace-Api-Key': 'YOUR-HUGGINGFACE-API-KEY' }, -}); - -const response = await client.graphql - .get() - .withClassName('Publication') - .withFields('name _additional{ certainty distance }') // note that certainty is only supported if distance==cosine - .withNearText({ - concepts: ['fashion'], - distance: 0.6, // prior to v1.14 use certainty instead of distance - moveAwayFrom: { - concepts: ['finance'], - force: 0.45, - }, - moveTo: { - concepts: ['haute couture'], - force: 0.85, - }, - }) - .do(); -console.log(response); -``` - diff --git a/_includes/code/graphql.filters.nearText.jinaai.mdx b/_includes/code/graphql.filters.nearText.jinaai.mdx index cfa58d6d..edcdc1bf 100644 --- a/_includes/code/graphql.filters.nearText.jinaai.mdx +++ b/_includes/code/graphql.filters.nearText.jinaai.mdx @@ -11,38 +11,6 @@ import FilteredTextBlock from '@site/src/components/Documentation/FilteredTextBl endMarker="# END NearTextJinaai" language="py" /> - - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'http', - host: 'localhost:8080', - headers: { 'X-Jinaai-Api-Key': process.env['YOUR_JINAAI_API_KEY'] }, -}); - -const response = await client.graphql - .get() - .withClassName('Publication') - .withFields('name _additional { certainty distance }') // note that certainty is only supported if distance==cosine - .withNearText({ - concepts: ['fashion'], - distance: 0.6, - moveAwayFrom: { - concepts: ['finance'], - force: 0.45, - }, - moveTo: { - concepts: ['haute couture'], - force: 0.85, - }, - }) - .do(); -console.log(response); -``` - diff --git a/_includes/code/graphql.filters.nearText.mdx b/_includes/code/graphql.filters.nearText.mdx index 530c31f3..a5bc24ee 100644 --- a/_includes/code/graphql.filters.nearText.mdx +++ b/_includes/code/graphql.filters.nearText.mdx @@ -9,37 +9,6 @@ import FilteredTextBlock from '@site/src/components/Documentation/FilteredTextBl text={PyCode} language="py" /> - - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'http', - host: 'localhost:8080', -}); - -const response = await client.graphql - .get() - .withClassName('Publication') - .withFields('name _additional{certainty distance}') // note that certainty is only supported if distance==cosine - .withNearText({ - concepts: ['fashion'], - distance: 0.6, // prior to v1.14 use certainty instead of distance - moveAwayFrom: { - concepts: ['finance'], - force: 0.45, - }, - moveTo: { - concepts: ['haute couture'], - force: 0.85, - }, - }) - .do(); -console.log(response); -``` - diff --git a/_includes/code/graphql.filters.nearText.openai.mdx b/_includes/code/graphql.filters.nearText.openai.mdx index bdf72ef8..cca8b0b9 100644 --- a/_includes/code/graphql.filters.nearText.openai.mdx +++ b/_includes/code/graphql.filters.nearText.openai.mdx @@ -11,38 +11,6 @@ import FilteredTextBlock from '@site/src/components/Documentation/FilteredTextBl endMarker="# END NearTextOpenAI" language="py" /> - - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'http', - host: 'localhost:8080', - headers: { 'X-OpenAI-Api-Key': process.env['OPENAI_API_KEY'] }, // Replace with your API key -}); - -const response = await client.graphql - .get() - .withClassName('Publication') - .withFields('name _additional { certainty distance }') // note that certainty is only supported if distance==cosine - .withNearText({ - concepts: ['fashion'], - distance: 0.6, // prior to v1.14 use certainty instead of distance - moveAwayFrom: { - concepts: ['finance'], - force: 0.45, - }, - moveTo: { - concepts: ['haute couture'], - force: 0.85, - }, - }) - .do(); -console.log(response); -``` - diff --git a/_includes/code/graphql.filters.nearText.palm.mdx b/_includes/code/graphql.filters.nearText.palm.mdx index 524ee873..9f100ef8 100644 --- a/_includes/code/graphql.filters.nearText.palm.mdx +++ b/_includes/code/graphql.filters.nearText.palm.mdx @@ -11,38 +11,6 @@ import FilteredTextBlock from '@site/src/components/Documentation/FilteredTextBl endMarker="# END NearTextGoogle" language="py" /> - - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'http', - host: 'localhost:8080', - headers: { 'X-PaLM-Api-Key': 'YOUR-PALM-API-KEY' }, -}); - -const response = await client.graphql - .get() - .withClassName('Publication') - .withFields('name _additional { certainty distance }') // note that certainty is only supported if distance==cosine - .withNearText({ - concepts: ['fashion'], - distance: 0.6, // prior to v1.14 use certainty instead of distance - moveAwayFrom: { - concepts: ['finance'], - force: 0.45, - }, - moveTo: { - concepts: ['haute couture'], - force: 0.85, - }, - }) - .do(); -console.log(response); -``` - diff --git a/_includes/code/graphql.filters.nearText.voyageai.mdx b/_includes/code/graphql.filters.nearText.voyageai.mdx index 55b48d97..be8f20fb 100644 --- a/_includes/code/graphql.filters.nearText.voyageai.mdx +++ b/_includes/code/graphql.filters.nearText.voyageai.mdx @@ -11,38 +11,6 @@ import FilteredTextBlock from '@site/src/components/Documentation/FilteredTextBl endMarker="# END NearTextVoyageAI" language="py" /> - - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'http', - host: 'localhost:8080', - headers: { 'X-VoyageAI-Api-Key': 'YOUR-VOYAGEAI-API-KEY' }, -}); - -const response = await client.graphql - .get() - .withClassName('Publication') - .withFields('name _additional{certainty distance}') // note that certainty is only supported if distance==cosine - .withNearText({ - concepts: ['fashion'], - distance: 0.6, // prior to v1.14 use certainty instead of distance - moveAwayFrom: { - concepts: ['finance'], - force: 0.45, - }, - moveTo: { - concepts: ['haute couture'], - force: 0.85, - }, - }) - .do(); -console.log(response); -``` - diff --git a/_includes/code/graphql.filters.nearVector.mdx b/_includes/code/graphql.filters.nearVector.mdx index 9e3584fe..85c3eb76 100644 --- a/_includes/code/graphql.filters.nearVector.mdx +++ b/_includes/code/graphql.filters.nearVector.mdx @@ -12,28 +12,6 @@ import PyCode from '!!raw-loader!/_includes/code/graphql.search-operators.py'; endMarker="END GraphQLnearVector" language="py" /> - - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'http', - host: 'localhost:8080', -}); - -const response = await client.graphql - .get() - .withClassName('Publication') - .withFields('name _additional {certainty}') - .withNearVector({ - vector: [0.1, -0.15, 0.3, ... ] // Replace with a compatible vector - }) - .do(); -console.log(response); -``` - diff --git a/_includes/code/graphql.filters.offset.mdx b/_includes/code/graphql.filters.offset.mdx index 5ce4ee5e..62095347 100644 --- a/_includes/code/graphql.filters.offset.mdx +++ b/_includes/code/graphql.filters.offset.mdx @@ -12,27 +12,6 @@ import PyCode from '!!raw-loader!/_includes/code/graphql.additional.py'; language="py" /> - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'http', - host: 'localhost:8080', -}); - -const response = await client.graphql - .get() - .withClassName('Article') - .withFields('title') - .withLimit(5) - .withOffset(2) - .do(); -console.log(response); -``` - - ```go diff --git a/_includes/code/graphql.filters.where.beacon.count.mdx b/_includes/code/graphql.filters.where.beacon.count.mdx index f87911da..cc34360b 100644 --- a/_includes/code/graphql.filters.where.beacon.count.mdx +++ b/_includes/code/graphql.filters.where.beacon.count.mdx @@ -12,30 +12,6 @@ import PyCode from '!!raw-loader!/_includes/code/graphql.filters.py'; endMarker="END FilterByCountOfReferences" language="py" /> - - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'http', - host: 'localhost:8080', -}); - -const response = await client.graphql - .get() - .withClassName('Author') - .withFields('name writesFor {... on Publication {name}}') - .withWhere({ - valueInt: 2, - operator: 'GreaterThanEqual', - path: ['writesFor'], - }) - .do(); -console.log(response); -``` - diff --git a/_includes/code/graphql.filters.where.beacon.mdx b/_includes/code/graphql.filters.where.beacon.mdx index 56b40c04..b3974bb2 100644 --- a/_includes/code/graphql.filters.where.beacon.mdx +++ b/_includes/code/graphql.filters.where.beacon.mdx @@ -12,30 +12,6 @@ import PyCode from '!!raw-loader!/_includes/code/graphql.filters.py'; endMarker="END FilterByReference" language="py" /> - - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'http', - host: 'localhost:8080', -}); - -const response = await client.graphql - .get() - .withClassName('Article') - .withFields('title inPublication{... on Publication{name}}') - .withWhere({ - path: ['inPublication', 'Publication', 'name'], - operator: 'Equal', - valueText: 'New Yorker', - }) - .do(); -console.log(response); -``` - diff --git a/_includes/code/graphql.filters.where.geocoordinates.mdx b/_includes/code/graphql.filters.where.geocoordinates.mdx index cffc8de5..5550427e 100644 --- a/_includes/code/graphql.filters.where.geocoordinates.mdx +++ b/_includes/code/graphql.filters.where.geocoordinates.mdx @@ -12,38 +12,6 @@ import PyCode from '!!raw-loader!/_includes/code/graphql.filters.py'; endMarker="END FilterByGeoCoordinates" language="py" /> - - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'http', - host: 'localhost:8080', -}); - -const response = await client.graphql - .get() - .withClassName('Publication') - .withFields('name headquartersGeoLocation {latitude longitude}') - .withWhere({ - operator: 'WithinGeoRange', - path: ['headquartersGeoLocation'], - valueGeoRange: { - geoCoordinates: { - latitude: 51.51, - longitude: -0.09, - }, - distance: { - max: 2000, - }, - }, - }) - .do(); -console.log(response); -``` - diff --git a/_includes/code/graphql.filters.where.id.mdx b/_includes/code/graphql.filters.where.id.mdx index 97c81f8d..8d3c8027 100644 --- a/_includes/code/graphql.filters.where.id.mdx +++ b/_includes/code/graphql.filters.where.id.mdx @@ -12,30 +12,6 @@ import PyCode from '!!raw-loader!/_includes/code/graphql.filters.py'; endMarker="END FilterById" language="py" /> - - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'http', - host: 'localhost:8080', -}); - -const response = await client.graphql - .get() - .withClassName('Article') - .withFields('title') - .withWhere({ - operator: 'Equal', - path: ['id'], - valueText: '00037775-1432-35e5-bc59-443baaef7d80', - }) - .do(); -console.log(response); -``` - diff --git a/_includes/code/graphql.filters.where.like.mdx b/_includes/code/graphql.filters.where.like.mdx index c472f22c..29e259ec 100644 --- a/_includes/code/graphql.filters.where.like.mdx +++ b/_includes/code/graphql.filters.where.like.mdx @@ -12,30 +12,6 @@ import PyCode from '!!raw-loader!/_includes/code/graphql.filters.py'; endMarker="END FilterWithLike" language="py" /> - - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'http', - host: 'localhost:8080', -}); - -const response = await client.graphql - .get() - .withClassName('Publication') - .withFields('name') - .withWhere({ - path: ['name'], - operator: 'Like', - valueText: 'New *', - }) - .do(); -console.log(response); -``` - diff --git a/_includes/code/graphql.filters.where.operands.mdx b/_includes/code/graphql.filters.where.operands.mdx index ef689a2b..eacc3836 100644 --- a/_includes/code/graphql.filters.where.operands.mdx +++ b/_includes/code/graphql.filters.where.operands.mdx @@ -12,37 +12,6 @@ import PyCode from '!!raw-loader!/_includes/code/graphql.filters.py'; endMarker="END MultipleConditionsFilter" language="py" /> - - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'http', - host: 'localhost:8080', -}); - -const response = await client.graphql - .get() - .withClassName('Article') - .withFields('title') - .withWhere({ - operator: 'And', - operands: [{ - path: ['wordCount'], - operator: 'GreaterThan', - valueInt: 1000, - }, { - path: ['title'], - operator: 'Like', - valueText:'*economy*', - }], - }) - .do(); -console.log(response); -``` - diff --git a/_includes/code/graphql.filters.where.simple.mdx b/_includes/code/graphql.filters.where.simple.mdx index 007d7553..b0696ece 100644 --- a/_includes/code/graphql.filters.where.simple.mdx +++ b/_includes/code/graphql.filters.where.simple.mdx @@ -12,30 +12,6 @@ import PyCode from '!!raw-loader!/_includes/code/graphql.filters.py'; endMarker="END SingleConditionFilter" language="py" /> - - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'http', - host: 'localhost:8080', -}); - -const response = await client.graphql - .get() - .withClassName('Article') - .withFields('title') - .withWhere({ - operator: 'GreaterThan', - path: ['wordCount'], - valueInt: 1000, - }) - .do(); -console.log(response); -``` - diff --git a/_includes/code/graphql.filters.where.timestamps.mdx b/_includes/code/graphql.filters.where.timestamps.mdx index 67e8cbbd..7db3c048 100644 --- a/_includes/code/graphql.filters.where.timestamps.mdx +++ b/_includes/code/graphql.filters.where.timestamps.mdx @@ -12,32 +12,6 @@ import PyCode from '!!raw-loader!/_includes/code/graphql.filters.py'; endMarker="END FilterByTimestamps" language="py" /> - - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'http', - host: 'localhost:8080', -}); - -const response = await client.graphql - .get() - .withClassName('Article') - .withFields('title') - .withWhere({ - operator: 'GreaterThan', - path: ['_creationTimeUnix'], - // valueDate: '2022-03-18T20:26:34.586-05:00', - // Can use either `valueDate` with a `RFC3339` datetime or `valueText` as Unix epoch milliseconds - valueText: '1647653359063', - }) - .do(); -console.log(response); -``` - diff --git a/_includes/code/graphql.get.beacon.mdx b/_includes/code/graphql.get.beacon.mdx index 035c88aa..38a5f7e5 100644 --- a/_includes/code/graphql.get.beacon.mdx +++ b/_includes/code/graphql.get.beacon.mdx @@ -15,25 +15,6 @@ import PyCodeV3 from '!!raw-loader!/_includes/code/graphql.get.beacon.v3.py'; language="py" /> - - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'http', - host: 'localhost:8080', -}); - -const response = await client.graphql - .get() - .withClassName('Article') - .withFields('title url wordCount inPublication {... on Publication {name}}') - .do(); -console.log(response); -``` - diff --git a/_includes/code/graphql.get.consistency.mdx b/_includes/code/graphql.get.consistency.mdx index 1c97a9af..086c2286 100644 --- a/_includes/code/graphql.get.consistency.mdx +++ b/_includes/code/graphql.get.consistency.mdx @@ -12,27 +12,6 @@ import PyCode from '!!raw-loader!/_includes/code/graphql.get.simple.py'; endMarker="END ConsistencyExample" language="py" /> - - - -```ts -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'http', - host: 'localhost:8080', -}); - -const response = await client.graphql - .get() - .withClassName('Article') - .withFields('_additional { id isConsistent }') - .withConsistencyLevel('QUORUM') - .do(); - -console.log(JSON.stringify(response, null, 2)); -``` - diff --git a/_includes/code/graphql.get.multitenancy.mdx b/_includes/code/graphql.get.multitenancy.mdx index a18a02ba..987b6e40 100644 --- a/_includes/code/graphql.get.multitenancy.mdx +++ b/_includes/code/graphql.get.multitenancy.mdx @@ -16,14 +16,6 @@ import GoCode from '!!raw-loader!/_includes/code/howto/go/docs/manage-data.multi /> - - - - - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'https', - host: 'WEAVIATE_INSTANCE_URL', // Replace with your Weaviate URL -}); - -const response = await client.graphql - .get() - .withClassName('JeopardyQuestion') - .withFields('question answer points') - .do(); -console.log(response); -``` - diff --git a/_includes/code/graphql.get.sorting.mdx b/_includes/code/graphql.get.sorting.mdx index 3f4eaf6a..41cf33c4 100644 --- a/_includes/code/graphql.get.sorting.mdx +++ b/_includes/code/graphql.get.sorting.mdx @@ -18,26 +18,6 @@ result = ( print(result) ``` - - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'http', - host: 'localhost:8080', -}); - -const response = await client.graphql - .get() - .withClassName('Article') - .withSort([{ path: ['title'], order: 'asc' }]) - .withFields('title url wordCount') - .do(); -console.log(response); -``` - diff --git a/_includes/code/graphql.underscoreproperties.certainty.mdx b/_includes/code/graphql.underscoreproperties.certainty.mdx index 2cbfff10..c087d674 100644 --- a/_includes/code/graphql.underscoreproperties.certainty.mdx +++ b/_includes/code/graphql.underscoreproperties.certainty.mdx @@ -45,26 +45,6 @@ query_result = ( print(query_result) ``` - - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'http', - host: 'localhost:8080', -}); - -const response = await client.graphql - .get() - .withClassName('Article') - .withNearText({ concepts: ['fashion'] }) - .withFields('title _additional { id certainty }') - .do(); -console.log(response); -``` - diff --git a/_includes/code/graphql.underscoreproperties.classification.mdx b/_includes/code/graphql.underscoreproperties.classification.mdx index dd0ab8eb..e2e74aa7 100644 --- a/_includes/code/graphql.underscoreproperties.classification.mdx +++ b/_includes/code/graphql.underscoreproperties.classification.mdx @@ -28,25 +28,6 @@ query_result = ( print(query_result) ``` - - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'http', - host: 'localhost:8080', -}); - -const response = await client.graphql - .get() - .withClassName('Article') - .withFields('title _additional { classification { basedOn classifiedFields completed id scope } }') - .do(); -console.log(response); -``` - diff --git a/_includes/code/graphql.underscoreproperties.distance.mdx b/_includes/code/graphql.underscoreproperties.distance.mdx index 0003889f..e6f86a7b 100644 --- a/_includes/code/graphql.underscoreproperties.distance.mdx +++ b/_includes/code/graphql.underscoreproperties.distance.mdx @@ -12,26 +12,6 @@ import PyCode from '!!raw-loader!/_includes/code/graphql.metadata.py'; endMarker="END MetadataUUIDDistance" language="py" /> - - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'http', - host: 'localhost:8080', -}); - -const response = await client.graphql - .get() - .withClassName('Article') - .withNearText({ concepts: ['fashion'] }) - .withFields('title _additional { id distance }') - .do(); -console.log(response); -``` - diff --git a/_includes/code/graphql.underscoreproperties.featureprojection.mdx b/_includes/code/graphql.underscoreproperties.featureprojection.mdx index 0200f855..3c3c15f7 100644 --- a/_includes/code/graphql.underscoreproperties.featureprojection.mdx +++ b/_includes/code/graphql.underscoreproperties.featureprojection.mdx @@ -38,33 +38,6 @@ query_result = ( print(query_result) ``` - - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'http', - host: 'localhost:8080', -}); - -const response = await client.graphql - .get() - .withClassName('Article') - .withFields('title _additional {featureProjection(dimensions: 2) { vector }}') - .withNearText({ - concepts:['music'], - moveTo: { - concepts: ['beatles'], - force: 0.5, - }, - }) - .withLimit(12) - .do(); -console.log(response); -``` - diff --git a/_includes/code/graphql.underscoreproperties.interpretation.mdx b/_includes/code/graphql.underscoreproperties.interpretation.mdx index 9be7e29d..cc808930 100644 --- a/_includes/code/graphql.underscoreproperties.interpretation.mdx +++ b/_includes/code/graphql.underscoreproperties.interpretation.mdx @@ -53,25 +53,6 @@ query_result = ( print(query_result) ``` - - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'http', - host: 'localhost:8080', -}); - -const response = await client.graphql - .get() - .withClassName('Publication') - .withFields('summary _additional { interpretation {source {concept occurrence weight}}}') - .do(); -console.log(response); -``` - diff --git a/_includes/code/graphql.underscoreproperties.nearestneighbors.mdx b/_includes/code/graphql.underscoreproperties.nearestneighbors.mdx index 2f11f72d..979ca5a9 100644 --- a/_includes/code/graphql.underscoreproperties.nearestneighbors.mdx +++ b/_includes/code/graphql.underscoreproperties.nearestneighbors.mdx @@ -61,32 +61,6 @@ query_result = ( print(query_result) ``` - - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'http', - host: 'localhost:8080', -}); - -const response = await client.graphql - .get() - .withClassName('Publication') - .withFields('name _additional { nearestNeighbors { neighbors { concept distance } } }') - .withNearText({ - concepts:['music'], - moveTo: { - concepts: ['beatles'], - force: 0.5, - }, - }) - .do(); -console.log(response); -``` - diff --git a/_includes/code/graphql.underscoreproperties.semanticpath.mdx b/_includes/code/graphql.underscoreproperties.semanticpath.mdx index 594ca848..d525cf97 100644 --- a/_includes/code/graphql.underscoreproperties.semanticpath.mdx +++ b/_includes/code/graphql.underscoreproperties.semanticpath.mdx @@ -12,37 +12,6 @@ import PyCode from '!!raw-loader!/_includes/code/graphql.search-operators.py'; endMarker="END GraphQLSemanticPath" language="py" /> - - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'http', - host: 'localhost:8080', -}); - -const response = await client.graphql - .get() - .withClassName('Publication') - .withFields('name _additional { semanticPath { path { concept distanceToNext distanceToPrevious distanceToQuery distanceToResult } } }') - .withNearText({ - concepts: ['fashion'], - distance: 0.6, // prior to v1.14 use certainty: 0.7 - moveAwayFrom: { - concepts: ['finance'], - force: 0.45, - }, - moveTo: { - concepts: ['haute couture'], - force: 0.85, - }, - }) - .do(); -console.log(response); -``` - diff --git a/_includes/code/howto.add.data.things.add.reference.mdx b/_includes/code/howto.add.data.things.add.reference.mdx index e72f4396..7b4a6cfd 100644 --- a/_includes/code/howto.add.data.things.add.reference.mdx +++ b/_includes/code/howto.add.data.things.add.reference.mdx @@ -29,41 +29,6 @@ client.data_object.reference.add( ) ``` - - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'http', - host: 'localhost:8080', -}); - -let response = await client.data - .creator() - .withClassName('Author') - .withId('36ddd591-2dee-4e7e-a3cc-eb86d30a4303') - .withProperties({ - name: 'Jodi Kantor', - }) - .do(); -console.log(response); - -response = await client.data - .referenceCreator() - .withId('36ddd591-2dee-4e7e-a3cc-eb86d30a4303') - .withReferenceProperty('writesFor') - .withReference( - client.data - .referencePayloadBuilder() - .withId('f81bfe5e-16ba-4615-a516-46c2ae2e5a80') - .payload(), - ) - .do(); -console.log(response); -``` - diff --git a/_includes/code/howto.add.data.things.mdx b/_includes/code/howto.add.data.things.mdx index 5a804d26..5f5df0eb 100644 --- a/_includes/code/howto.add.data.things.mdx +++ b/_includes/code/howto.add.data.things.mdx @@ -20,28 +20,6 @@ client.data_object.create( ) ``` - - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'http', - host: 'localhost:8080', -}); - -const response = await client.data - .creator() - .withClassName('Publication') - .withId('f81bfe5e-16ba-4615-a516-46c2ae2e5a80') - .withProperties({ - name: 'New York Times', - }) - .do(); -console.log(response); -``` - diff --git a/_includes/code/howto.add.data.things.reference.mdx b/_includes/code/howto.add.data.things.reference.mdx index 50e6673d..f97ae866 100644 --- a/_includes/code/howto.add.data.things.reference.mdx +++ b/_includes/code/howto.add.data.things.reference.mdx @@ -26,31 +26,6 @@ data_uuid = ( ) ``` - - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'http', - host: 'localhost:8080', -}); - -const response = await client.data - .creator() - .withClassName('Author') - .withId('36ddd591-2dee-4e7e-a3cc-eb86d30a4303') - .withProperties({ - name: 'Jodi Kantor', - writesFor: [{ - beacon: 'weaviate://localhost/f81bfe5e-16ba-4615-a516-46c2ae2e5a80', - }], - }) - .do(); -console.log(response); -``` - diff --git a/_includes/code/howto.customvectors.adddata.mdx b/_includes/code/howto.customvectors.adddata.mdx index ca63e6d4..925afc0c 100644 --- a/_includes/code/howto.customvectors.adddata.mdx +++ b/_includes/code/howto.customvectors.adddata.mdx @@ -21,29 +21,6 @@ client.data_object.create( ) ``` - - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'http', - host: 'localhost:8080', -}); - -const response = await client.data - .creator() - .withClassName('Post') - .withId('36ddd591-2dee-4e7e-a3cc-eb86d30a0934') - .withProperties({ - content: 'This is a news update of May 28 2021. Today .......', - }) - .withVector([0.3, 0.2, 0.1, 0.4, 0.6, 0.9]) - .do(); -console.log(response); -``` - diff --git a/_includes/code/howto.customvectors.nearvector.mdx b/_includes/code/howto.customvectors.nearvector.mdx index 5a0a5c0e..90cd9f61 100644 --- a/_includes/code/howto.customvectors.nearvector.mdx +++ b/_includes/code/howto.customvectors.nearvector.mdx @@ -35,26 +35,6 @@ nearVector = {vector: [-0.36840257,0.13973749,-0.28994447,-0.18607682,0.20019795 client.query.get("Post", ["content", "_additional {certainty}"]).with_near_vector(nearVector).do() # note that certainty is only supported if distance==cosine ``` - - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'http', - host: 'localhost:8080', -}); - -const response = await client.graphql - .get() - .withClassName('Post') - .withFields('content _additional { certainty distance }') // certainty is only supported if distance==cosine - .withNearVector({ vector: [-0.36840257,0.13973749,-0.28994447,-0.18607682,0.20019795,0.15541431,-0.42353877,0.30262852,0.2724561,0.07069917,0.4877447,0.038771532,0.64523,-0.15907241,-0.3413626,-0.026682584,-0.63310874,-0.33411884,0.082939014,0.30305764,0.045918174,-0.21439327,-0.5005205,0.6210859,-0.2729049,-0.51221114,0.09680918,0.094923325,-0.15688285,-0.07325482,0.6588305,0.0523736,-0.14173415,-0.27428055,0.25526586,0.057506185,-0.3103442,0.028601522,0.124522656,0.66984487,0.12160647,-0.5090515,-0.540393,-0.39546522,-0.2201204,0.34625968,-0.21068871,0.21132985,0.048714135,0.09043683,0.3176081,-0.056684002,-0.12117501,-0.6591976,-0.26731065,0.42615625,0.33333477,-0.3240578,-0.18771006,0.2328068,-0.17239179,-0.33583146,-0.6556605,-0.10608161,-0.5135395,-0.25123677,-0.23004892,0.7036331,0.04456794,0.41253626,0.27872285,-0.28226635,0.11927197,-0.4677766,0.4343466,-0.17538455,0.10621233,0.95815116,0.23587844,-0.006406698,-0.10512518,-1.1125883,-0.37921682,0.040789194,0.676718,0.3369762,0.040712647,0.580487,0.20063736,-0.021220192,-0.09071747,-0.0023735985,0.30007777,-0.039925132,0.4035474,-0.2518212,-0.17846306,0.12371392,-0.0703354,-0.3752431,-0.652917,0.5952828,1.3426708,-0.08167235,-0.38515738,0.058423538,-0.08100355,-0.192886,0.3745164,-0.23291737,0.33326542,-0.6019264,-0.42822492,-0.6524583,-0.15210791,-0.5073593,0.022548754,-0.058033653,-0.47369233,-0.30890635,0.6338296,0.0017854869,0.1954949,0.99348027,-0.26558784,-0.058124136,1.149388,0.02915948,0.013422121,0.25484946,-0.030017598,-0.23879935,0.053123385,-0.36463016,-0.0024245526,0.1202083,-0.45966506,-0.34140104,-0.08484162,-0.03537422,-0.2817959,0.25044164,-0.5060605,0.1252808,-0.032539487,0.110069446,-0.20679846,-0.46421885,-0.4141739,0.26994973,-0.070687145,0.16862138,-0.20162229,0.22199251,-0.2771402,0.23653336,0.16585203,-0.08286354,-0.15343396,0.23893964,-0.7453282,-0.16549355,-0.1947069,0.46136436,0.22064126,0.28654936,-0.038697664,0.037633028,-0.80988157,0.5094175,-0.0920082,0.25405347,-0.64169943,0.43366328,-0.2999211,-0.4090591,0.11957859,0.00803617,-0.0433745,0.12818244,0.28464508,-0.31760025,0.16558012,-0.33553946,-0.3943465,0.59569097,-0.6524206,0.3683173,-0.60456693,0.2046492,0.46010277,0.24695799,0.2946015,0.11376746,-0.027988048,0.03749422,-0.16577742,0.23407385,-0.0231737,-0.023245076,0.08752677,0.2299883,0.35467404,0.046193745,-0.39828986,0.21079691,0.38396686,-0.0018698421,0.16047359,-0.057517264,-0.203534,0.23438136,-0.84250915,0.22371331,0.0058325706,0.30733636,0.19518353,-0.108008966,0.6509316,0.070131645,-0.24023099,0.28779706,0.2326336,0.07004021,-0.45955566,0.20426086,-0.37472793,-0.049604423,0.4537271,0.6133582,-1.0527759,-0.5472505,0.15193434,0.5296606,-0.11560251,0.07279209,0.40557706,0.2505283,0.24490519,0.017602902,-0.004647707,0.16608049,0.12576887,0.118216865,0.4403996,0.39552462,-0.22196701,-0.061155193,0.03693534,-0.4022908,0.3842317,-0.0831345,0.01930883,0.3446575,-0.2167439,-0.23994556,-0.09370326,-0.3671856,0.044011243,0.017895095,-0.019855855,-0.16416992,0.17858285,0.31287143,0.38368022,-0.006513525,0.45780763,-0.23027879,0.108570844,-0.4449492,-0.035763215,0.03818417,0.040017277,-0.17022872,-0.2622464,0.65610534,0.16720143,0.2515769,-0.23535803,0.62484455,0.16771325,-0.62404263,0.19176348,-0.72786695,0.18485649,-0.30914405,-0.3230534,-0.24064465,0.28841522,0.39792386,0.15618932,0.03928854,0.18277727,-0.101632096,0.1868196,-0.33366352,0.086561844,0.48557812,-0.6198209,-0.07978742]}) - .do(); -console.log(response); -``` - diff --git a/_includes/code/howto.customvectors.schemacreate.mdx b/_includes/code/howto.customvectors.schemacreate.mdx index 2a014b8d..82eb5f32 100644 --- a/_includes/code/howto.customvectors.schemacreate.mdx +++ b/_includes/code/howto.customvectors.schemacreate.mdx @@ -21,33 +21,6 @@ class_obj = { client.schema.create_class(class_obj) ``` - - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'http', - host: 'localhost:8080', -}); - -const classObj = { - class: 'Post', - vectorizer: 'none', // explicitly tell Weaviate not to vectorize anything, we are providing the vectors ourselves through our BERT model - properties: [{ - name: 'content', - dataType: ['text'], - }], -}; - -const response = await client.schema - .classCreator() - .withClass(classObj) - .do(); -console.log(response); -``` - diff --git a/_includes/code/howto.query.data.mdx b/_includes/code/howto.query.data.mdx index b83935e3..9d59acca 100644 --- a/_includes/code/howto.query.data.mdx +++ b/_includes/code/howto.query.data.mdx @@ -48,30 +48,6 @@ query_result = ( print(query_result) ``` - - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'http', - host: 'localhost:8080', -}); - -const response = await client.graphql - .get() - .withClassName('Article') - .withFields('title url wordCount HasAuthors { ... on Author { name } }') - .withWhere({ - operator: 'Equal', - path: ['inPublication', 'Publication', 'name'], - valueText:'Wired', - }) - .do(); -console.log(response); -``` - diff --git a/_includes/code/howto.schema.create.mdx b/_includes/code/howto.schema.create.mdx index f11aa048..9d78bdd4 100644 --- a/_includes/code/howto.schema.create.mdx +++ b/_includes/code/howto.schema.create.mdx @@ -33,45 +33,6 @@ class_obj = { client.schema.create_class(class_obj) ``` - - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'http', - host: 'localhost:8080', -}); - -const classObj = { - class: 'Publication', - description: 'A publication with an online source', - properties: [ - { - dataType: [ - 'string', - ], - description: 'Name of the publication', - name: 'name', - }, - { - dataType: [ - 'geoCoordinates', - ], - description: 'Geo location of the HQ', - name: 'headquartersGeoLocation', - }, - ], -}; - -const response = await client.schema - .classCreator() - .withClass(classObj) - .do(); -console.log(response); -``` - diff --git a/_includes/code/howto.schema.property.add.mdx b/_includes/code/howto.schema.property.add.mdx index 35348f1d..0ea359b6 100644 --- a/_includes/code/howto.schema.property.add.mdx +++ b/_includes/code/howto.schema.property.add.mdx @@ -20,35 +20,6 @@ reference_property = { client.schema.property.create("Publication", reference_property) ``` - - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'http', - host: 'localhost:8080', -}); - -const className = 'Publication'; -const prop = { - dataType: [ - 'Article', - ], - description: 'The articles this publication has', - name: 'hasArticles', -}; - -const response = await client.schema - .propertyCreator() - .withClassName(className) - .withProperty(prop) - .do(); -console.log(response); - -``` - diff --git a/_includes/code/howto.semanticsearch.filter.mdx b/_includes/code/howto.semanticsearch.filter.mdx index c297f669..c33fabe5 100644 --- a/_includes/code/howto.semanticsearch.filter.mdx +++ b/_includes/code/howto.semanticsearch.filter.mdx @@ -60,37 +60,6 @@ query_result = ( print(query_result) ``` - - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'http', - host: 'localhost:8080', -}); - -const response = await client.graphql - .get() - .withClassName('Publication') - .withFields('name') - .withNearText({ - concepts: ['fashion'], - distance: 0.6, // prior to v1.14 use certainty: 0.7, - moveAwayFrom: { - concepts: ['finance'], - force: 0.45, - }, - moveTo: { - concepts: ['haute couture'], - force: 0.85, - }, - }) - .do(); -console.log(response); -``` - diff --git a/_includes/code/howto.semanticsearch.function.mdx b/_includes/code/howto.semanticsearch.function.mdx index ad70ee63..460baa30 100644 --- a/_includes/code/howto.semanticsearch.function.mdx +++ b/_includes/code/howto.semanticsearch.function.mdx @@ -62,30 +62,6 @@ query_result = client.query.raw(get_articles_query) print(query_result) ``` - - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'http', - host: 'localhost:8080', -}); - -const response = await client.graphql - .explore() - .withNearText({ - concepts: ['fashion'], - moveTo: { concepts: ['haute couture'], force: 0.85 }, - moveAwayFrom: { concepts: ['finance'], force: 0.45 }, - certainty: 0.7, - }) - .withFields('beacon certainty className') - .do(); -console.log(response); -``` - diff --git a/_includes/code/howto/manage-data.create.with.geo.mdx b/_includes/code/howto/manage-data.create.with.geo.mdx index f71e191c..ed49e695 100644 --- a/_includes/code/howto/manage-data.create.with.geo.mdx +++ b/_includes/code/howto/manage-data.create.with.geo.mdx @@ -15,7 +15,7 @@ import PyCode from '!!raw-loader!/_includes/code/howto/manage-data.create.py'; /> - + ```js const publication = client.collections.use('Publication') @@ -34,25 +34,6 @@ uuid = await publication.data.insert({ console.log('UUID: ', uuid) ``` - - - -```js -const response = await client.data - .creator() - .withClassName('Publication') - .withId('df48b9f6-ba48-470c-bf6a-57657cb07390') - .withProperties({ - 'name': 'Elsevier', - 'headquartersGeoLocation': { - 'latitude': 52.3932696, - 'longitude': 4.8374263, - }, - }) - .do(); -console.log(JSON.stringify(response, null, 2)); -``` - diff --git a/_includes/code/howto/manage-data.read.check.existence.mdx b/_includes/code/howto/manage-data.read.check.existence.mdx index a9e56e82..b652bbd7 100644 --- a/_includes/code/howto/manage-data.read.check.existence.mdx +++ b/_includes/code/howto/manage-data.read.check.existence.mdx @@ -16,7 +16,7 @@ import PyCode from '!!raw-loader!/_includes/code/howto/manage-data.create.py'; - + ```js import { generateUuid5 } from 'weaviate-client'; @@ -36,18 +36,6 @@ const authorExists = await authors.data.exists(object_uuid) console.log('Author exists: ' + authorExists) ``` - - - -```js -const response = await client.data - .checker() - .withClassName('Author') - .withId('df48b9f6-ba48-470c-bf6a-57657cb07390') - .do(); -console.log(response); -``` - diff --git a/_includes/code/howto/manage-data.shards.inspect.mdx b/_includes/code/howto/manage-data.shards.inspect.mdx index e626ba96..16d496d0 100644 --- a/_includes/code/howto/manage-data.shards.inspect.mdx +++ b/_includes/code/howto/manage-data.shards.inspect.mdx @@ -15,7 +15,7 @@ import JavaCode from '!!raw-loader!/_includes/code/howto/java/src/test/java/io/w /> - + ```js let articles = client.collections.use('Article') @@ -26,17 +26,6 @@ const shards = await articles.config.getShards() console.log(JSON.stringify(shards, null, 2)); ``` - - - -```js -const response = await client.schema - .shardsGetter() - .withClassName('Article') - .do(); -console.log(JSON.stringify(response, null, 2)); -``` - diff --git a/_includes/code/howto/manage-data.shards.update.mdx b/_includes/code/howto/manage-data.shards.update.mdx index 1053ff24..622109b5 100644 --- a/_includes/code/howto/manage-data.shards.update.mdx +++ b/_includes/code/howto/manage-data.shards.update.mdx @@ -16,7 +16,7 @@ import JavaCode from '!!raw-loader!/_includes/code/howto/java/src/test/java/io/w /> - + ```js let articles = client.collections.use('Article') @@ -27,19 +27,6 @@ const shards = await articles.config.updateShards('READY', 'shard-1234') console.log(JSON.stringify(shards, null, 2)); ``` - - - -```js -const shards = await client.schema.shardUpdater() - .withClassName('Article') - .withShardName('shard-1234') - .withStatus('READY') - .do() - -console.log(JSON.stringify(shards, null, 2)); -``` - - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'http', - host: 'localhost:8080', -}); - -const object = await client.data - .creator() - .withClassName('FashionItem') - .withProperties({ - labelName: 'Mickey Mouse T-shirt' - image: 'iVBORw0KGgoAAAANS...' - }) -.do(); - -console.log(JSON.stringify(object, null, 2)); -``` - diff --git a/_includes/code/img2vec-neural.nearimage.encode.mdx b/_includes/code/img2vec-neural.nearimage.encode.mdx index f2220321..932b2fb7 100644 --- a/_includes/code/img2vec-neural.nearimage.encode.mdx +++ b/_includes/code/img2vec-neural.nearimage.encode.mdx @@ -55,29 +55,6 @@ result = ( print(result) ``` - - - -```js -// The TypeScript client doesn't have a helper function for base64 image encoding - -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'http', - host: 'localhost:8080', -}); - -const response = await client.graphql - .get() - .withClassName('FashionItem') - .withFields('image') - .withNearImage({ image: '/9j/4AAQSkZJRgABAgE...' }) - .do(); - -console.log(JSON.stringify(response, null, 2)); -``` - diff --git a/_includes/code/img2vec-neural.nearimage.mdx b/_includes/code/img2vec-neural.nearimage.mdx index 57826783..820d3c4d 100644 --- a/_includes/code/img2vec-neural.nearimage.mdx +++ b/_includes/code/img2vec-neural.nearimage.mdx @@ -21,27 +21,6 @@ result = ( print(result) ``` - - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'http', - host: 'localhost:8080', -}); - -const response = await client.graphql - .get() - .withClassName('FashionItem') - .withFields('image') - .withNearImage({ image: '/9j/4AAQSkZJRgABAgE...' }) - .do(); - -console.log(JSON.stringify(response, null, 2)); -``` - diff --git a/_includes/code/ner-transformers-module.mdx b/_includes/code/ner-transformers-module.mdx index 4ec5d827..e1fab4f6 100644 --- a/_includes/code/ner-transformers-module.mdx +++ b/_includes/code/ner-transformers-module.mdx @@ -47,25 +47,6 @@ result = ( print(result) ``` - - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'http', - host: 'localhost:8080', -}); - -const response = await client.graphql - .get() - .withClassName('Article') - .withFields('title _additional { tokens (properties: [\'title\'], limit: 1, certainty: 0.7) {entity property word certainty startPosition endPosition} }') - .do(); -console.log(response); -``` - diff --git a/_includes/code/qna-openai.ask.mdx b/_includes/code/qna-openai.ask.mdx index 516a7adb..71c5947d 100644 --- a/_includes/code/qna-openai.ask.mdx +++ b/_includes/code/qna-openai.ask.mdx @@ -58,31 +58,6 @@ result = ( print(result) ``` - - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'http', - host: 'localhost:8080', - headers: { 'X-OpenAI-Api-Key': 'YOUR-OPENAI-API-KEY' }, -}); - -const response = await client.graphql - .get() - .withClassName('Article') - .withAsk({ - question: 'Who is Stanley Kubrick?', - properties: ['summary'], - }) - .withFields('title _additional { answer { hasAnswer property result startPosition endPosition } }') - .withLimit(1) - .do(); -console.log(response); -``` - diff --git a/_includes/code/qna-transformers.ask.mdx b/_includes/code/qna-transformers.ask.mdx index b4ac2c78..2e5e30c3 100644 --- a/_includes/code/qna-transformers.ask.mdx +++ b/_includes/code/qna-transformers.ask.mdx @@ -12,35 +12,6 @@ import PyCode from '!!raw-loader!/_includes/code/graphql.search-operators.py'; endMarker="END GraphQLQnAExample" language="py" /> - - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'https', - host: 'edu-demo.weaviate.network', - apiKey: new weaviate.ApiKey('learn-weaviate'), - headers: { - 'X-OpenAI-Api-Key': process.env['OPENAI_API_KEY'], - }, -}); - -const response = await client.graphql - .get() - .withClassName('Article') - .withAsk({ - question: 'Who is the king of the Netherlands?', - properties: ['summary'], - }) - .withFields('title _additional { answer { hasAnswer property result startPosition endPosition } }') - .withLimit(1) - .do(); -console.log(response); - -``` - diff --git a/_includes/code/quickstart.autoschema.connect.docker.mdx b/_includes/code/quickstart.autoschema.connect.docker.mdx index 12e53dd4..83730b0f 100644 --- a/_includes/code/quickstart.autoschema.connect.docker.mdx +++ b/_includes/code/quickstart.autoschema.connect.docker.mdx @@ -14,16 +14,6 @@ import EndToEndTSCode from '!!raw-loader!/_includes/code/quickstart/endtoend.ts' language="py" /> - - - - - diff --git a/_includes/code/quickstart.autoschema.connect.nokey.mdx b/_includes/code/quickstart.autoschema.connect.nokey.mdx index af6dc254..81d604b9 100644 --- a/_includes/code/quickstart.autoschema.connect.nokey.mdx +++ b/_includes/code/quickstart.autoschema.connect.nokey.mdx @@ -12,18 +12,6 @@ client = weaviate.Client( ) ``` - - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'https', - host: 'WEAVIATE_INSTANCE_URL', // Replace with your Weaviate endpoint -}); -``` - diff --git a/_includes/code/quickstart.byov.all.mdx b/_includes/code/quickstart.byov.all.mdx index c446bb7a..6a688ac2 100644 --- a/_includes/code/quickstart.byov.all.mdx +++ b/_includes/code/quickstart.byov.all.mdx @@ -18,17 +18,6 @@ import ByovAllPyCode from '!!raw-loader!/_includes/code/quickstart.byov.all.py'; - - -import ByovAllTsCode from '!!raw-loader!/_includes/code/quickstart.byov.all.ts'; - - - - {/* ```go diff --git a/_includes/code/quickstart.byov.schema.mdx b/_includes/code/quickstart.byov.schema.mdx index 5e6c259a..a6a00c84 100644 --- a/_includes/code/quickstart.byov.schema.mdx +++ b/_includes/code/quickstart.byov.schema.mdx @@ -5,7 +5,6 @@ import TabItem from '@theme/TabItem'; import FilteredTextBlock from '@site/src/components/Documentation/FilteredTextBlock'; import ByovAllPyCode from '!!raw-loader!/_includes/code/quickstart.byov.all.py'; import ByovAllTsCode from '!!raw-loader!/_includes/code/quickstart.byov.all.ts'; -import ByovAllTsCodeLegacy from '!!raw-loader!/_includes/code/quickstart.byov.all.legacy.ts'; import ByovAllShCode from '!!raw-loader!/_includes/code/quickstart.byov.all.sh'; @@ -17,7 +16,7 @@ import ByovAllShCode from '!!raw-loader!/_includes/code/quickstart.byov.all.sh'; language="py" /> - + - - - - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'https', - host: 'WEAVIATE_INSTANCE_URL', // Replace with your Weaviate endpoint -}); - -const response = await client - .data - .getter() - .do(); -console.log(JSON.stringify(response, null, 2)); -``` - {/* diff --git a/_includes/code/quickstart.import.questions-and-vectors.mdx b/_includes/code/quickstart.import.questions-and-vectors.mdx index 1c5c36b7..97e82cc0 100644 --- a/_includes/code/quickstart.import.questions-and-vectors.mdx +++ b/_includes/code/quickstart.import.questions-and-vectors.mdx @@ -5,7 +5,6 @@ import TabItem from '@theme/TabItem'; import FilteredTextBlock from '@site/src/components/Documentation/FilteredTextBlock'; import ByovAllPyCode from '!!raw-loader!/_includes/code/quickstart.byov.all.py'; import ByovAllTsCode from '!!raw-loader!/_includes/code/quickstart.byov.all.ts'; -import ByovAllTsCodeLegacy from '!!raw-loader!/_includes/code/quickstart.byov.all.legacy.ts'; @@ -17,7 +16,7 @@ import ByovAllTsCodeLegacy from '!!raw-loader!/_includes/code/quickstart.byov.al language="py" /> - + - -The import uses the `node-fetch` library.

- -```bash -npm install node-fetch -``` - - - diff --git a/_includes/code/quickstart.import.questions.mdx b/_includes/code/quickstart.import.questions.mdx index b2270dd4..b06cc856 100644 --- a/_includes/code/quickstart.import.questions.mdx +++ b/_includes/code/quickstart.import.questions.mdx @@ -39,64 +39,6 @@ with client.batch as batch: batch.add_data_object(properties, "Question") ``` - - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'https', - host: 'WEAVIATE_INSTANCE_URL', // Replace with your Weaviate endpoint - headers: { 'X-OpenAI-Api-Key': 'YOUR-OPENAI-API-KEY' }, // Replace with your API key -}); - -async function getJsonData() { - const file = await fetch('https://raw.githubusercontent.com/weaviate-tutorials/quickstart/main/data/jeopardy_tiny.json'); - return file.json(); -} - -async function importQuestions() { - // Get the data from the data.json file - const data = await getJsonData(); - - // Prepare a batcher - let batcher = client.batch.objectsBatcher(); - let counter = 0; - const batchSize = 100; - - for (const question of data) { - // Construct an object with a class and properties 'answer' and 'question' - const obj = { - class: 'Question', - properties: { - answer: question.Answer, - question: question.Question, - category: question.Category, - }, - }; - - // add the object to the batch queue - batcher = batcher.withObject(obj); - - // When the batch counter reaches batchSize, push the objects to Weaviate - if (counter++ == batchSize) { - // flush the batch queue - await batcher.do(); - - // restart the batch queue - counter = 0; - batcher = client.batch.objectsBatcher(); - } - } - - // Flush the remaining objects - await batcher.do(); -} - -await importQuestions(); -``` - {/* diff --git a/_includes/code/quickstart.query.aggregate.1.mdx b/_includes/code/quickstart.query.aggregate.1.mdx index d1d8d5fd..30e48950 100644 --- a/_includes/code/quickstart.query.aggregate.1.mdx +++ b/_includes/code/quickstart.query.aggregate.1.mdx @@ -40,27 +40,6 @@ result = ( print(json.dumps(result, indent=4)) ``` - - - -```js -import weaviate, { ApiKey } from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'https', - host: 'WEAVIATE_INSTANCE_URL', // Replace with your Weaviate endpoint - apiKey: new ApiKey('YOUR-WEAVIATE-API-KEY'), // Replace with your Weaviate API key - headers: { 'X-OpenAI-Api-Key': process.env['OPENAI_API_KEY'] }, // Replace with your API key -}); - -const response = await client.graphql - .aggregate() - .withClassName('Question') - .withFields('meta { count }') - .do(); -console.log(JSON.stringify(response, null, 2)); -``` - {/* diff --git a/_includes/code/quickstart.query.aggregate.2.mdx b/_includes/code/quickstart.query.aggregate.2.mdx index 2a38ca76..792ee028 100644 --- a/_includes/code/quickstart.query.aggregate.2.mdx +++ b/_includes/code/quickstart.query.aggregate.2.mdx @@ -53,31 +53,6 @@ result = ( print(json.dumps(result, indent=4)) ``` - - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'https', - host: 'WEAVIATE_INSTANCE_URL', // Replace with your Weaviate endpoint - headers: { 'X-OpenAI-Api-Key': process.env['OPENAI_API_KEY'] }, // Replace with your API key -}); - -const response = await client.graphql - .aggregate() - .withClassName('Question') - .withFields('meta { count }') - .withWhere({ - path: ['category'], - operator: 'Equal', - valueText: 'ANIMALS', - }) - .do(); -console.log(JSON.stringify(response, null, 2)); -``` - {/* diff --git a/_includes/code/quickstart.query.nearVector.mdx b/_includes/code/quickstart.query.nearVector.mdx index d26dea6d..b7ad465c 100644 --- a/_includes/code/quickstart.query.nearVector.mdx +++ b/_includes/code/quickstart.query.nearVector.mdx @@ -15,7 +15,7 @@ import ByovAllPyCode from '!!raw-loader!/_includes/code/quickstart.byov.all.py'; /> - + import ByovAllTsCode from '!!raw-loader!/_includes/code/quickstart.byov.all.ts'; @@ -28,18 +28,6 @@ import ByovAllTsCode from '!!raw-loader!/_includes/code/quickstart.byov.all.ts'; - - -import ByovAllTsCodeLegacy from '!!raw-loader!/_includes/code/quickstart.byov.all.legacy.ts'; - - - - diff --git a/_includes/code/quickstart.query.neartext.additional.mdx b/_includes/code/quickstart.query.neartext.additional.mdx index 14aae221..00f15c0c 100644 --- a/_includes/code/quickstart.query.neartext.additional.mdx +++ b/_includes/code/quickstart.query.neartext.additional.mdx @@ -47,28 +47,6 @@ result = ( print(json.dumps(result, indent=4)) ``` - - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'https', - host: 'WEAVIATE_INSTANCE_URL', // Replace with your Weaviate endpoint - headers: { 'X-OpenAI-Api-Key': process.env['OPENAI_API_KEY'] }, // Replace with your API key -}); - -const response = await client.graphql - .get() - .withClassName('Question') - .withFields('question answer category _additional {certainty}') - .withNearText({ concepts: ['biology'] }) - .withLimit(2) - .do(); -console.log(JSON.stringify(response, null, 2)); -``` - {/* diff --git a/_includes/code/quickstart.query.where.1.mdx b/_includes/code/quickstart.query.where.1.mdx index 8c556f8d..41f98aab 100644 --- a/_includes/code/quickstart.query.where.1.mdx +++ b/_includes/code/quickstart.query.where.1.mdx @@ -39,32 +39,6 @@ result = ( print(json.dumps(result, indent=4)) ``` - - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'https', - host: 'WEAVIATE_INSTANCE_URL', // Replace with your Weaviate endpoint - headers: { 'X-OpenAI-Api-Key': process.env['OPENAI_API_KEY'] }, // Replace with your API key -}); - -const response = await client.graphql - .get() - .withClassName('Question') - .withFields('question answer category') - .withNearText({ concepts: ['biology'] }) - .withWhere({ - path: ['category'], - operator: 'Equal', - valueText: 'ANIMALS', - }) - .do(); -console.log(JSON.stringify(response, null, 2)); -``` - {/* diff --git a/_includes/code/quickstart.query.where.2.mdx b/_includes/code/quickstart.query.where.2.mdx index 9080bea2..c05a47ca 100644 --- a/_includes/code/quickstart.query.where.2.mdx +++ b/_includes/code/quickstart.query.where.2.mdx @@ -42,33 +42,6 @@ result = ( print(json.dumps(result, indent=4)) ``` - - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'https', - host: 'WEAVIATE_INSTANCE_URL', // Replace with your Weaviate endpoint - headers: { 'X-OpenAI-Api-Key': process.env['OPENAI_API_KEY'] }, // Replace with your API key -}); - -const response = await client.graphql - .get() - .withClassName('Question') - .withFields('question answer category _additional { id certainty }') - .withNearText({ concepts: ['biology'] }) - .withWhere({ - path: ['category'], - operator: 'Equal', - valueText: 'ANIMALS', - }) - .withLimit(2) - .do(); -console.log(JSON.stringify(response, null, 2)); -``` - {/* diff --git a/_includes/code/quickstart/collection.definition.mdx b/_includes/code/quickstart/collection.definition.mdx index 31869a41..59b2b828 100644 --- a/_includes/code/quickstart/collection.definition.mdx +++ b/_includes/code/quickstart/collection.definition.mdx @@ -4,7 +4,6 @@ import FilteredTextBlock from '@site/src/components/Documentation/FilteredTextBl import EndToEndPyCode from '!!raw-loader!/_includes/code/quickstart/endtoend.py'; import EndToEndPy3Code from '!!raw-loader!/_includes/code/quickstart/endtoend.py3.py'; import EndToEndTSCode from '!!raw-loader!/_includes/code/quickstart/endtoend.ts'; -import EndToEndTSCodeLegacy from '!!raw-loader!/_includes/code/quickstart/endtoend-v2.ts'; import GoCollectionDefine from '!!raw-loader!/_includes/code/quickstart/go-collection-define.go'; @@ -18,7 +17,7 @@ import GoCollectionDefine from '!!raw-loader!/_includes/code/quickstart/go-colle /> - + - - - - + ```ts import weaviate, { WeaviateClient } from 'weaviate-client' @@ -46,20 +46,6 @@ const client: WeaviateClient = await weaviate.connectToWeaviateCloud( - - -```ts -import weaviate, { WeaviateClient, ObjectsBatcher, ApiKey } from 'weaviate-ts-client'; -import fetch from 'node-fetch'; - -const client: WeaviateClient = weaviate.client({ - scheme: 'https', - host: 'WEAVIATE_INSTANCE_URL', // Replace with your Weaviate endpoint - apiKey: new ApiKey('YOUR-WEAVIATE-API-KEY'), // Replace with your Weaviate instance API key -}); -``` - - ```go diff --git a/_includes/code/quickstart/connect.partial.mdx b/_includes/code/quickstart/connect.partial.mdx index 63cdb9e4..b708d706 100644 --- a/_includes/code/quickstart/connect.partial.mdx +++ b/_includes/code/quickstart/connect.partial.mdx @@ -24,7 +24,7 @@ client.is_ready() ``` - + ```ts import weaviate, { WeaviateClient } from 'weaviate-client' @@ -41,20 +41,6 @@ const client: WeaviateClient = await weaviate.connectToWeaviateCloud(weaviateURL - - -```ts -import weaviate, { WeaviateClient, ObjectsBatcher, ApiKey } from 'weaviate-ts-client'; -import fetch from 'node-fetch'; - -const client: WeaviateClient = weaviate.client({ - scheme: 'https', - host: 'WEAVIATE_INSTANCE_URL', // Replace with your Weaviate endpoint - apiKey: new ApiKey('YOUR-WEAVIATE-API-KEY'), // Replace with your Weaviate instance API key -}); -``` - - For `curl`, add the API key to the header as shown below: diff --git a/_includes/code/quickstart/connect.withkey.mdx b/_includes/code/quickstart/connect.withkey.mdx index 6e6ada7a..8aeee23e 100644 --- a/_includes/code/quickstart/connect.withkey.mdx +++ b/_includes/code/quickstart/connect.withkey.mdx @@ -4,7 +4,6 @@ import FilteredTextBlock from '@site/src/components/Documentation/FilteredTextBl import EndToEndPyCode from '!!raw-loader!/_includes/code/quickstart/endtoend.py'; import EndToEndPy3Code from '!!raw-loader!/_includes/code/quickstart/endtoend.py3.py'; import EndToEndTSCode from '!!raw-loader!/_includes/code/quickstart/endtoend.ts'; -import EndToEndTSCodeLegacy from '!!raw-loader!/_includes/code/quickstart/endtoend-v2.ts'; import GoConnectCode from '!!raw-loader!/_includes/code/quickstart/go-connect.go'; @@ -20,7 +19,7 @@ import GoConnectCode from '!!raw-loader!/_includes/code/quickstart/go-connect.go /> - + - - - - - @@ -17,7 +16,7 @@ import GoCreateAll from '!!raw-loader!/_includes/code/quickstart/go-create-run-a language="py" /> - + - - - @@ -35,7 +34,7 @@ import GoGenGrouped from '!!raw-loader!/_includes/code/quickstart/go-query-gener language="py" /> - + - - - @@ -35,7 +34,7 @@ import GoGenerative from '!!raw-loader!/_includes/code/quickstart/go-query-gener language="py" /> - + - - - - - - - - diff --git a/_includes/code/quickstart/import.mdx b/_includes/code/quickstart/import.mdx index b0183957..47f139c7 100644 --- a/_includes/code/quickstart/import.mdx +++ b/_includes/code/quickstart/import.mdx @@ -3,7 +3,6 @@ import TabItem from '@theme/TabItem'; import FilteredTextBlock from '@site/src/components/Documentation/FilteredTextBlock'; import EndToEndPyCode from '!!raw-loader!/_includes/code/quickstart/endtoend.py'; import EndToEndTSCode from '!!raw-loader!/_includes/code/quickstart/endtoend.ts'; -import EndToEndTSCodeLegacy from '!!raw-loader!/_includes/code/quickstart/endtoend-v2.ts'; import GoImportObjects from '!!raw-loader!/_includes/code/quickstart/go-add-objects.go'; @@ -15,7 +14,7 @@ import GoImportObjects from '!!raw-loader!/_includes/code/quickstart/go-add-obje language="py" /> - + - - - @@ -36,7 +35,7 @@ import GoNearText from '!!raw-loader!/_includes/code/quickstart/go-query-neartex /> - + - - - GoNearText diff --git a/_includes/code/quickstart/neartext.where.mdx b/_includes/code/quickstart/neartext.where.mdx index 089e0b53..b38ba149 100644 --- a/_includes/code/quickstart/neartext.where.mdx +++ b/_includes/code/quickstart/neartext.where.mdx @@ -4,7 +4,6 @@ import FilteredTextBlock from '@site/src/components/Documentation/FilteredTextBl import EndToEndPyCode from '!!raw-loader!/_includes/code/quickstart/endtoend.py'; import EndToEndPy3Code from '!!raw-loader!/_includes/code/quickstart/endtoend.py3.py'; import EndToEndTSCode from '!!raw-loader!/_includes/code/quickstart/endtoend.ts'; -import EndToEndTSCodeLegacy from '!!raw-loader!/_includes/code/quickstart/endtoend-v2.ts'; import GoWhereFilter from '!!raw-loader!/_includes/code/quickstart/go-query-filter.go'; @@ -35,7 +34,7 @@ import GoWhereFilter from '!!raw-loader!/_includes/code/quickstart/go-query-filt language="py" /> - + - - - - + - - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'http', - host: 'localhost:8080', -}); - -const response = await client.data - .getterById() - .withClassName('MyClass') - .withId('36ddd591-2dee-4e7e-a3cc-eb86d30a4303') - .withConsistencyLevel('ONE') // default QUORUM - .do(); -console.log(JSON.stringify(response, null, 2)); - -// The parameter passed to `withConsistencyLevel` can be one of: -// * 'ALL', -// * 'QUORUM' (default), or -// * 'ONE'. -// -// It determines how many replicas must acknowledge a request -// before it is considered successful. -``` - diff --git a/_includes/code/schema.things.create.replication.mdx b/_includes/code/schema.things.create.replication.mdx index 9a49f637..94ba68c3 100644 --- a/_includes/code/schema.things.create.replication.mdx +++ b/_includes/code/schema.things.create.replication.mdx @@ -2,7 +2,6 @@ import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; import PyCode from '!!raw-loader!/_includes/code/howto/manage-data.collections.py'; import TSCode from '!!raw-loader!/_includes/code/howto/manage-data.collections.ts'; -import TSCodeLegacy from '!!raw-loader!/_includes/code/howto/manage-data.collections-v2.ts'; import FilteredTextBlock from '@site/src/components/Documentation/FilteredTextBlock'; @@ -17,7 +16,7 @@ import FilteredTextBlock from '@site/src/components/Documentation/FilteredTextBl - + - - - diff --git a/_includes/code/schema.things.properties.add.mdx b/_includes/code/schema.things.properties.add.mdx index 3962739b..348b8e1d 100644 --- a/_includes/code/schema.things.properties.add.mdx +++ b/_includes/code/schema.things.properties.add.mdx @@ -15,7 +15,7 @@ import JavaCode from '!!raw-loader!/_includes/code/howto/java/src/test/java/io/w /> - + ```js let articles = client.collections.use('Article') @@ -28,24 +28,6 @@ articles.config.addProperty({ // highlight-end ``` - - - -```js -const className = 'Article'; -const prop = { - dataType: ['boolean'], - name: 'onHomepage', -}; - -const response = await client.schema - .propertyCreator() - .withClassName(className) - .withProperty(prop) - .do(); -console.log(JSON.stringify(response, null, 2)); -``` - diff --git a/_includes/code/spellcheck-module.mdx b/_includes/code/spellcheck-module.mdx index 304bd65e..f38bfc3a 100644 --- a/_includes/code/spellcheck-module.mdx +++ b/_includes/code/spellcheck-module.mdx @@ -49,28 +49,6 @@ result = ( print(result) ``` - - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'http', - host: 'localhost:8080', -}); - -const response = await client.graphql - .get() - .withClassName('Article') - .withFields('title _additional { spellCheck { change {corrected original} didYouMean location originalText } }') - .withNearText({ - concepts: ['houssing prices'], - }) - .do(); -console.log(JSON.stringify(response, null, 2)); -``` - diff --git a/_includes/code/sum-transformers-module.mdx b/_includes/code/sum-transformers-module.mdx index 11c8d214..05acec92 100644 --- a/_includes/code/sum-transformers-module.mdx +++ b/_includes/code/sum-transformers-module.mdx @@ -41,25 +41,6 @@ result = ( print(result) ``` - - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'http', - host: 'localhost:8080', -}); - -const response = await client.graphql - .get() - .withClassName('Article') - .withFields('title _additional { summary ( properties: ["summary"]) { property result } }') - .do(); -console.log(JSON.stringify(response, null, 2)); -``` - diff --git a/_includes/code/tutorial.schema.create.mdx b/_includes/code/tutorial.schema.create.mdx index 801ebc96..e0a0ec7c 100644 --- a/_includes/code/tutorial.schema.create.mdx +++ b/_includes/code/tutorial.schema.create.mdx @@ -13,52 +13,6 @@ import PyCode from '!!raw-loader!/_includes/code/starter-guides/schema.py'; language="py" /> - - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'https', - host: 'WEAVIATE_INSTANCE_URL', // Replace with your Weaviate endpoint -}); - -// Define the 'Question' class -const classObj = { - class: 'Question', - description: 'Information from a Jeopardy! question', // description of the class - properties: [ - { - name: 'question', - dataType: ['text'], - description: 'The question', - }, - { - name: 'answer', - dataType: ['text'], - description: 'The answer', - }, - { - name: 'category', - dataType: ['text'], - description: 'The question category', - }, - ], - vectorizer: 'text2vec-openai', - moduleConfig: { - generative-openai: {} // Set `generative-openai` as the generative module - } -}; - -// Add the class to the schema -await client - .schema - .classCreator() - .withClass(classObj) - .do(); -``` - {/* diff --git a/_includes/code/tutorial.schema.index-settings.mdx b/_includes/code/tutorial.schema.index-settings.mdx index ac9ff7c9..bbf2a435 100644 --- a/_includes/code/tutorial.schema.index-settings.mdx +++ b/_includes/code/tutorial.schema.index-settings.mdx @@ -15,7 +15,7 @@ import PyCode from '!!raw-loader!/_includes/code/starter-guides/schema.py'; - + ```js import weaviate from 'weaviate-client'; @@ -67,73 +67,6 @@ const newCollection = await client.collections.create(collectionObj) - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'https', - host: 'WEAVIATE_INSTANCE_URL', // Replace with your Weaviate endpoint -}); - -// Define the 'Question' class -const classObj = { - class: 'Question', - description: 'Information from a Jeopardy! question', // description of the class - vectorizer: 'text2vec-openai', - moduleConfig: { - generative-openai: {} // Set `generative-openai` as the generative module - }, - properties: [ - { - name: 'question', - dataType: ['text'], - description: 'The question', - moduleConfig: { - 'text2vec-openai': { // this must match the vectorizer used - vectorizePropertyName: true, - tokenization: 'lowercase' // Use "lowercase" tokenization - }, - } - }, - { - name: 'answer', - dataType: ['text'], - description: 'The answer', - moduleConfig: { - 'text2vec-openai': { // this must match the vectorizer used - vectorizePropertyName: false, - tokenization: 'whitespace' // Use "whitespace" tokenization - }, - } - }, - ], - // highlight-start - // Configure the vector index - vectorIndexType: 'hnsw', // Or `flat` or `dynamic` - vectorIndexConfig: { - distance: 'cosine', - bq: { - enabled: True, - }, - }, - // Configure the inverted index - indexTimestamps: true, - indexNullState: true, - indexPropertyLength: true, - // highlight-end -}; - -// Add the class to the schema -await client - .schema - .classCreator() - .withClass(classObj) - .do(); -``` - - {/* ```go diff --git a/_includes/code/tutorial.schema.multi-tenancy.mdx b/_includes/code/tutorial.schema.multi-tenancy.mdx index e8b6febf..916b46d2 100644 --- a/_includes/code/tutorial.schema.multi-tenancy.mdx +++ b/_includes/code/tutorial.schema.multi-tenancy.mdx @@ -15,7 +15,7 @@ import PyCode from '!!raw-loader!/_includes/code/starter-guides/schema.py'; - + ```js import weaviate from 'weaviate-client'; @@ -58,62 +58,6 @@ const newCollection = await client.collections.create(collectionObj) - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'https', - host: 'WEAVIATE_INSTANCE_URL', // Replace with your Weaviate endpoint -}); - -// Define the 'Question' class -const classObj = { - class: 'Question', - description: 'Information from a Jeopardy! question', // description of the class - vectorizer: 'text2vec-openai', - moduleConfig: { - generative-openai: {} // Set `generative-openai` as the generative module - }, - properties: [ - { - name: 'question', - dataType: ['text'], - description: 'The question', - moduleConfig: { - 'text2vec-openai': { // this must match the vectorizer used - vectorizePropertyName: true, - tokenization: 'lowercase' // Use "lowercase" tokenization - }, - } - }, - { - name: 'answer', - dataType: ['text'], - description: 'The answer', - moduleConfig: { - 'text2vec-openai': { // this must match the vectorizer used - vectorizePropertyName: false, - tokenization: 'whitespace' // Use "whitespace" tokenization - }, - } - }, - ], - // highlight-start - multiTenancyConfig: { enabled: true } // Enable multi-tenancy - // highlight-end -}; - -// Add the class to the schema -await client - .schema - .classCreator() - .withClass(classObj) - .do(); -``` - - {/* ```go diff --git a/_includes/code/tutorial.schema.properties.options.mdx b/_includes/code/tutorial.schema.properties.options.mdx index 1a510b2c..ca68fab3 100644 --- a/_includes/code/tutorial.schema.properties.options.mdx +++ b/_includes/code/tutorial.schema.properties.options.mdx @@ -15,7 +15,7 @@ import PyCode from '!!raw-loader!/_includes/code/starter-guides/schema.py'; - + ```js import weaviate from 'weaviate-client'; @@ -56,59 +56,6 @@ const newCollection = await client.collections.create(collectionObj) - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'https', - host: 'WEAVIATE_INSTANCE_URL', // Replace with your Weaviate endpoint -}); - -// Define the 'Question' class -const classObj = { - class: 'Question', - description: 'Information from a Jeopardy! question', // description of the class - vectorizer: 'text2vec-openai', - moduleConfig: { - generative-openai: {} // Set `generative-openai` as the generative module - }, - properties: [ - { - name: 'question', - dataType: ['text'], - description: 'The question', - moduleConfig: { - 'text2vec-openai': { // this must match the vectorizer used - vectorizePropertyName: true, - tokenization: 'lowercase' // Use "lowercase" tokenization - }, - } - }, - { - name: 'answer', - dataType: ['text'], - description: 'The answer', - moduleConfig: { - 'text2vec-openai': { // this must match the vectorizer used - vectorizePropertyName: false, - tokenization: 'whitespace' // Use "whitespace" tokenization - }, - } - }, - ] -}; - -// Add the class to the schema -await client - .schema - .classCreator() - .withClass(classObj) - .do(); -``` - - {/* ```go diff --git a/_includes/code/tutorials.wikipedia.hybrid.mdx b/_includes/code/tutorials.wikipedia.hybrid.mdx index 533e45d3..8e57e932 100644 --- a/_includes/code/tutorials.wikipedia.hybrid.mdx +++ b/_includes/code/tutorials.wikipedia.hybrid.mdx @@ -38,24 +38,6 @@ result = ( print(json.dumps(result, indent=4)) ``` - - - -```js -const hybridResult = await client.graphql - .get() - .withClassName('Article') - .withFields('title content _additional{score}') - .withHybrid({ - query: 'jackfruit', - alpha: 0.5, // optional, defaults to 0.75 - }) - .withLimit(3) - .do(); - -console.log('hybrid: jackfruit = ', JSON.stringify(hybridResult.data['Get']['Article'], null, 2)); -``` - {/* diff --git a/_includes/code/tutorials.wikipedia.import.mdx b/_includes/code/tutorials.wikipedia.import.mdx index 3bf4dfc3..adef9bc7 100644 --- a/_includes/code/tutorials.wikipedia.import.mdx +++ b/_includes/code/tutorials.wikipedia.import.mdx @@ -46,56 +46,5 @@ with client.batch as batch: print(f"Finished importing {counter} articles.") ``` - - - -```js -// ===== Import data ===== -import fs from 'fs'; -import csv from 'csv-parser'; - -async function importCSV(filePath) { - let batcher = client.batch.objectsBatcher(); - let counter = 0; - const batchSize = 100; - - return new Promise((resolve, reject) => { - fs.createReadStream(filePath) - .pipe(csv()) - .on('data', async (row) => { - // Import each record - const obj = { - class: 'Article', - properties: { - title: row.title, - content: row.text, - url: row.url, - }, - vector: JSON.parse(row['content_vector']), - } - // Add the object to the batch queue - batcher = batcher.withObject(obj); - counter++; - - // When the batch counter reaches batchSize, push the objects to Weaviate - if (counter % batchSize === 0) { - console.log(`Imported ${counter} articles...`); - // Flush the batch queue and restart it - await batcher.do(); - batcher = client.batch.objectsBatcher(); - } - }) - .on('end', async () => { - // Flush the remaining objects - await batcher.do(); - console.log(`Finished importing ${counter} articles.`); - resolve(); - }); - }); -} - -await importCSV('vector_database_wikipedia_articles_embedded.csv'); -``` - diff --git a/_includes/code/tutorials.wikipedia.nearText.mdx b/_includes/code/tutorials.wikipedia.nearText.mdx index c978db5b..d52cf461 100644 --- a/_includes/code/tutorials.wikipedia.nearText.mdx +++ b/_includes/code/tutorials.wikipedia.nearText.mdx @@ -45,21 +45,6 @@ result = ( print(json.dumps(result, indent=4)) ``` - - - -```js -const nearTextResult = await client.graphql - .get() - .withClassName('Article') - .withFields('title content') - .withNearText({ concepts: ['modern art in Europe'] }) - .withLimit(1) - .do(); - -console.log('nearText: modern art in Europe = ', JSON.stringify(nearTextResult.data['Get']['Article'], null, 2)); -``` - {/* diff --git a/_includes/code/tutorials.wikipedia.schema.mdx b/_includes/code/tutorials.wikipedia.schema.mdx index 6af54c7f..7ddb4b17 100644 --- a/_includes/code/tutorials.wikipedia.schema.mdx +++ b/_includes/code/tutorials.wikipedia.schema.mdx @@ -44,52 +44,5 @@ print('Created schema'); - - -```js -try { - await client.schema.classDeleter().withClassName('Article').do(); - console.log('Deleted existing Articles'); -} catch (e) { - if (!e.match(/could not find class/)) - throw e; -} - -// ===== Create Article class for the schema ===== -const articleClass = { - class: 'Article', - description: 'An article from the Simple English Wikipedia data set', - vectorizer: 'text2vec-openai', - moduleConfig: { - // Match how OpenAI created the embeddings for the `content` (`text`) field - 'text2vec-openai': { - model: 'ada', - modelVersion: '002', - type: 'text', - vectorizeClassName: false, - }, - }, - properties: [ - { - name: 'title', - description: 'The title of the article', - dataType: ['string'], - // Don't vectorize the title - moduleConfig: { 'text2vec-openai': { skip: true } }, - }, - { - name: 'content', - description: 'The content of the article', - dataType: ['text'], - }, - ], -}; - -// Add the Article class to the schema -await client.schema.classCreator().withClass(articleClass).do(); -console.log('Created schema'); -``` - - diff --git a/_includes/code/wcs.authentication.api.key.edu-demo.mdx b/_includes/code/wcs.authentication.api.key.edu-demo.mdx index 77b5ff6c..1401a813 100644 --- a/_includes/code/wcs.authentication.api.key.edu-demo.mdx +++ b/_includes/code/wcs.authentication.api.key.edu-demo.mdx @@ -19,24 +19,6 @@ client = weaviate.Client( ) ``` - - - -```ts -import weaviate, { ApiKey } from 'weaviate-ts-client'; - -// Instantiate the client with the auth config -const client = weaviate.client({ - scheme: 'https', - host: 'edu-demo.weaviate.network', - apiKey: new ApiKey('learn-weaviate'), - headers: { - // Only needed if using an inference service (e.g. `nearText`, `hybrid` or `generative` queries) - 'X-OpenAI-Api-Key': process.env['OPENAI_API_KEY'], // Replace with your API key - }, -}); -``` - diff --git a/_includes/code/wcs.authentication.api.key.mdx b/_includes/code/wcs.authentication.api.key.mdx index f57da348..bd3dd6b2 100644 --- a/_includes/code/wcs.authentication.api.key.mdx +++ b/_includes/code/wcs.authentication.api.key.mdx @@ -24,7 +24,7 @@ import PyCode from '!!raw-loader!/_includes/code/tutorials/connect.py'; /> - + ```ts import weaviate from 'weaviate-client'; @@ -37,20 +37,6 @@ const client = await weaviate.connectToWeaviateCloud( ) ``` - - - -```ts -import weaviate, { ApiKey } from 'weaviate-ts-client'; - -// Instantiate the client with the auth config -const client = weaviate.client({ - scheme: 'https', - host: 'WEAVIATE_INSTANCE_URL', // Replace WEAVIATE_INSTANCE_URL with your instance URL - apiKey: new ApiKey(weaviateKey), -}); -``` - diff --git a/_includes/code/wcs.authentication.api.key.with.inference.key.mdx b/_includes/code/wcs.authentication.api.key.with.inference.key.mdx index 57ba562a..0aa3da1d 100644 --- a/_includes/code/wcs.authentication.api.key.with.inference.key.mdx +++ b/_includes/code/wcs.authentication.api.key.with.inference.key.mdx @@ -13,7 +13,7 @@ import PyCode from '!!raw-loader!/_includes/code/tutorials/connect.py'; language="py" /> - + ```js import weaviate, { ApiKey } from 'weaviate-client'; @@ -31,25 +31,6 @@ const client = await weaviate.connectToWeaviateCloud( ) ``` - - - -```js -import weaviate, { ApiKey } from 'weaviate-ts-client'; - -var cohereKey = process.env.COHERE_API_KEY; // Recommended: save to an environment variable - -// Instantiate the client with the auth config -const client = weaviate.client({ - scheme: 'https', - host: 'WEAVIATE_INSTANCE_URL', // Replace WEAVIATE_INSTANCE_URL with your instance URL - apiKey: new ApiKey(weaviateKey), // Replace with your Weaviate instance API key - headers: { - 'X-Cohere-Api-Key': cohereKey, // Replace with your Cohere API key - }, -}); -``` - diff --git a/_includes/code/wcs.authentication.api.key.with.openai.key.mdx b/_includes/code/wcs.authentication.api.key.with.openai.key.mdx index 0da91a25..43d13782 100644 --- a/_includes/code/wcs.authentication.api.key.with.openai.key.mdx +++ b/_includes/code/wcs.authentication.api.key.with.openai.key.mdx @@ -18,23 +18,6 @@ client = weaviate.Client( ) ``` - - - -```ts -import weaviate, { ApiKey } from 'weaviate-ts-client'; - -// Instantiate the client with the auth config -const client = weaviate.client({ - scheme: 'https', - host: 'WEAVIATE_INSTANCE_URL', // Replace WEAVIATE_INSTANCE_URL with your instance URL - apiKey: new ApiKey('YOUR-WEAVIATE-API-KEY'), // Replace with your Weaviate instance API key - headers: { - 'X-OpenAI-Api-Key': process.env['OPENAI_API_KEY'], // Replace with your API key - }, -}); -``` - diff --git a/_includes/code/wcs.authentication.user.pass.mdx b/_includes/code/wcs.authentication.user.pass.mdx index f018f80c..d4a480e8 100644 --- a/_includes/code/wcs.authentication.user.pass.mdx +++ b/_includes/code/wcs.authentication.user.pass.mdx @@ -13,7 +13,7 @@ import PyCode from '!!raw-loader!/_includes/code/tutorials/connect.py'; language="py" /> - + ```ts import weaviate from 'weaviate-client'; @@ -30,22 +30,6 @@ const client = await weaviate.connectToWeaviateCloud( - - -```ts -import weaviate, { AuthUserPasswordCredentials } from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: "https", - host: "WEAVIATE_INSTANCE_URL", // Replace with your Weaviate endpoint - authClientSecret: new AuthUserPasswordCredentials({ - username: wcdUsername, // Replace with your Weaviate Cloud username - password: wcdPassword, // Replace with your Weaviate Cloud password - }) -}); -``` - - ```go diff --git a/_includes/code/wcs.client.is_ready.mdx b/_includes/code/wcs.client.is_ready.mdx index 8d8c844e..5095b365 100644 --- a/_includes/code/wcs.client.is_ready.mdx +++ b/_includes/code/wcs.client.is_ready.mdx @@ -12,7 +12,7 @@ import PyClientCode from '!!raw-loader!/_includes/code/wcs.client.is_ready.py'; language="py" /> - + ```js import weaviate, { WeaviateClient } from 'weaviate-client'; @@ -26,24 +26,6 @@ const response = await client.isReady(); console.log(response); ``` - - - -```js -import weaviate, { WeaviateClient, ObjectsBatcher, ApiKey } from 'weaviate-ts-client'; - -const client: WeaviateClient = weaviate.client({ - scheme: 'https', - host: 'WEAVIATE_INSTANCE_URL', // Replace with your Weaviate endpoint - apiKey: new ApiKey('YOUR-WEAVIATE-API-KEY'), // Replace with your Weaviate instance API key -}); - -const response = await client.misc - .readyChecker() - .do(); -console.log(response); -``` - diff --git a/_includes/code/wcs.without.authentication.mdx b/_includes/code/wcs.without.authentication.mdx index 4fa13226..803a64a4 100644 --- a/_includes/code/wcs.without.authentication.mdx +++ b/_includes/code/wcs.without.authentication.mdx @@ -13,7 +13,7 @@ import PyCode from '!!raw-loader!/_includes/code/tutorials/connect.py'; /> - + ```ts import weaviate from 'weaviate-client'; @@ -25,18 +25,6 @@ const client: WeaviateClient = await weaviate.connectToWeaviateCloud( - - -```ts -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'https', - host: 'WEAVIATE_INSTANCE_URL', // Replace with your Weaviate endpoint -}); -``` - - ```go diff --git a/_includes/how.to.get.object.count.mdx b/_includes/how.to.get.object.count.mdx index ad68e109..cb125c02 100644 --- a/_includes/how.to.get.object.count.mdx +++ b/_includes/how.to.get.object.count.mdx @@ -12,25 +12,6 @@ import PyCode from '!!raw-loader!/_includes/code/graphql.aggregate.simple.py'; endMarker="END GraphQLMetaCount" language="py" /> - - - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'https', - host: 'WEAVIATE_INSTANCE_URL', // Replace with your instance URL -}); - -const response = await client.graphql - .aggregate() - .withClassName() - .withFields('meta { count }') - .do(); -console.log(JSON.stringify(response, null, 2)); -``` - diff --git a/_includes/schema-delete-class.mdx b/_includes/schema-delete-class.mdx index b9d9f49f..db4dd315 100644 --- a/_includes/schema-delete-class.mdx +++ b/_includes/schema-delete-class.mdx @@ -32,7 +32,7 @@ This code deletes a collection and its objects. /> - + ```ts // delete collection "Article" - THIS WILL DELETE THE COLLECTION AND ALL ITS DATA @@ -44,17 +44,6 @@ await client.collections.delete('Article') - - -```ts -// delete collection "Article" - THIS WILL DELETE THE COLLECTION AND ALL ITS DATA -await client.schema - .classDeleter() - .withClassName('Article') - .do(); -``` - - diff --git a/docs/academy/_snippets/academy.clients.graphql.raw.mdx b/docs/academy/_snippets/academy.clients.graphql.raw.mdx index bc6df5a9..1d7be890 100644 --- a/docs/academy/_snippets/academy.clients.graphql.raw.mdx +++ b/docs/academy/_snippets/academy.clients.graphql.raw.mdx @@ -25,13 +25,6 @@ result = client.query.raw(query) print(result) ``` - - - -```js -Coming soon -``` - diff --git a/docs/academy/js/standalone/which-search/05_review.mdx b/docs/academy/js/standalone/which-search/05_review.mdx index 30d6672c..d79753aa 100644 --- a/docs/academy/js/standalone/which-search/05_review.mdx +++ b/docs/academy/js/standalone/which-search/05_review.mdx @@ -17,7 +17,7 @@ These code examples are runnable, with the [`v3` Weaviate Typescript client](../ - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + -{/* - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'https', - host: 'WEAVIATE_INSTANCE_URL', // Replace WEAVIATE_INSTANCE_URL with your instance URL -}); - -const response = await client.graphql - .get() - .withClassName('WikiArticle') - .withFields('title wiki_summary') - .do(); -console.log(JSON.stringify(response, null, 2)); -``` - @@ -111,5 +92,5 @@ public class App { } ``` - */} + diff --git a/docs/academy/py/zero_to_mvp/101_hello_weaviate/_snippets/academy.clients.rest.object.get.mdx b/docs/academy/py/zero_to_mvp/101_hello_weaviate/_snippets/academy.clients.rest.object.get.mdx index caf18b19..db47ee32 100644 --- a/docs/academy/py/zero_to_mvp/101_hello_weaviate/_snippets/academy.clients.rest.object.get.mdx +++ b/docs/academy/py/zero_to_mvp/101_hello_weaviate/_snippets/academy.clients.rest.object.get.mdx @@ -19,25 +19,6 @@ client = weaviate.Client("http://localhost:8080") print(client.get_meta()) ``` - -{/* - -```js -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'https', - host: 'WEAVIATE_INSTANCE_URL', // Replace WEAVIATE_INSTANCE_URL with your instance URL -}); - -const response = await client.data - .getterById() - .withClassName('WikiArticle') - .withId('36ddd591-2dee-4e7e-a3cc-eb86d30a4303') - .do(); -console.log(JSON.stringify(response, null, 2)); -``` - @@ -102,5 +83,5 @@ public class App { } ``` - */} + diff --git a/docs/contributor-guide/weaviate-docs/development.mdx b/docs/contributor-guide/weaviate-docs/development.mdx index 4d3fb006..cc9124a0 100644 --- a/docs/contributor-guide/weaviate-docs/development.mdx +++ b/docs/contributor-guide/weaviate-docs/development.mdx @@ -140,7 +140,7 @@ import JavaCode from "!!raw-loader!/_includes/code/howto/java/src/test/java/io/w language="py" /> - + - + - - - - + - - - - + - - - - + - + - - - - + - - - - + - - - @@ -320,7 +311,7 @@ Configure replication settings, such as [async replication](/deploy/configuratio /> - + - - - ```bash diff --git a/docs/deploy/configuration/replica-movement.mdx b/docs/deploy/configuration/replica-movement.mdx index 3d436340..8103d539 100644 --- a/docs/deploy/configuration/replica-movement.mdx +++ b/docs/deploy/configuration/replica-movement.mdx @@ -28,7 +28,7 @@ import PyCode from '!!raw-loader!/_includes/code/python/howto.configure.replica. language="py" /> - + ```typescript // JS/TS support coming soon @@ -76,7 +76,7 @@ endMarker="# END ReplicateShard" language="py" /> - + ```typescript // JS/TS support coming soon @@ -121,7 +121,7 @@ endMarker="# END CheckOperationStatus" language="py" /> - + ```typescript // JS/TS support coming soon @@ -181,7 +181,7 @@ endMarker="# END ListReplicationOperations" language="py" /> - + ```typescript // JS/TS support coming soon @@ -227,7 +227,7 @@ endMarker="# END CancelOperation" language="py" /> - + ```typescript // JS/TS support coming soon @@ -263,7 +263,7 @@ endMarker="# END DeleteOperationRecord" language="py" /> - + ```typescript // JS/TS support coming soon @@ -299,7 +299,7 @@ endMarker="# END DeleteAllOperationRecords" language="py" /> - + ```typescript // JS/TS support coming soon diff --git a/docs/deploy/tutorials/rbac.mdx b/docs/deploy/tutorials/rbac.mdx index 4f7ede30..44cb6a3d 100644 --- a/docs/deploy/tutorials/rbac.mdx +++ b/docs/deploy/tutorials/rbac.mdx @@ -112,7 +112,7 @@ Ensure you are connected to Weaviate with a user possessing sufficient permissio language="py" /> - + - + - + ```ts // TS support coming soon @@ -220,7 +220,7 @@ Now, you can assign the role `rw_role` to `custom-user`: language="py" /> - + - + - + - + ```ts // TS support coming soon @@ -369,7 +369,7 @@ Now, you can assign the role `viewer_role` to `custom-user`: language="py" /> - + - + - + - + ```ts // TS support coming soon @@ -520,7 +520,7 @@ Now, you can assign the role `tenant_manager` to `custom-user`: language="py" /> - + - - - - - - - - - - - - +The Weaviate JS/TS Client `v2` has been deprecated and should no longer be used. If you need documentation for the `v2` client, see the documentation archive. If you are migrating from the JS/TS `v2` client to the `v3` client, see this dedicated guide. ## Code examples & further resources diff --git a/docs/weaviate/client-libraries/typescript/typescript-v2.mdx b/docs/weaviate/client-libraries/typescript/typescript-v2.mdx deleted file mode 100644 index a40be08d..00000000 --- a/docs/weaviate/client-libraries/typescript/typescript-v2.mdx +++ /dev/null @@ -1,440 +0,0 @@ ---- -title: JS/TS client v2 -sidebar_position: 20 -description: "Legacy TypeScript client v2 documentation for maintaining existing applications and compatibility." -image: og/docs/client-libraries.jpg -# tags: ['TypeScript', 'client library'] ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -:::note TypeScript client version -The TypeScript client is version `v||site.typescript_client_version||`. Use the [TypeScript v3 client](./index.mdx) for new projects. -::: - -The TypeScript client can be used for both JavaScript and TypeScript scripts. - -## Installation and setup - -To install the TypeScript client library package, use [npm](https://www.npmjs.com/). - -```bash -npm install weaviate-ts-client -``` - -## Usage and type definitions - -Once installed, you can use the client in your TypeScript and JavaScript scripts, as shown in the following examples. - -### Usage - - - - -```js -const { default: weaviate } = require('weaviate-ts-client'); - -const client = weaviate.client({ - scheme: 'https', - host: 'WEAVIATE_INSTANCE_URL', // Replace with your Weaviate endpoint -}); - -client - .schema - .getter() - .do() - .then(res => { - console.log(res); - }) - .catch(err => { - console.error(err) - }); -``` - - - - -```ts -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'https', - host: 'WEAVIATE_INSTANCE_URL', // Replace with your Weaviate endpoint -}); - -const response = await client - .schema - .getter() - .do(); -console.log(response); -``` - - - - -:::tip Troubleshooting imports with TypeScript -If you are having any issues with the import statement in TypeScript (e.g. if `weaviate` is `undefined`), try adding `"esModuleInterop": true` to your `"compilerOptions"` in `tsconfig.json`. -::: - -### Type definitions - -The type definitions can be found under the `types` subdirectory of the package in the `*.d.ts` files, for example as shown on the [npm package page](https://www.npmjs.com/package/weaviate-ts-client?activeTab=code). - -## Authentication - -import ClientAuthIntro from '/docs/weaviate/client-libraries/_components/client.auth.introduction.mdx' - - - - -### API key authentication - -import ClientAuthApiKey from '/docs/weaviate/client-libraries/_components/client.auth.api.key.mdx' - - - - - - -```js -const { default: weaviate } = require('weaviate-ts-client'); - -// Instantiate the client with the auth config -const client = weaviate.client({ - scheme: 'https', - host: 'edu-demo.weaviate.network', // Replace with your Weaviate endpoint - apiKey: new weaviate.ApiKey('learn-weaviate'), // Replace with your Weaviate instance API key -}); -``` - - - - -```ts -import weaviate, { WeaviateClient, ApiKey } from 'weaviate-ts-client'; - -// Instantiate the client with the auth config -const client: WeaviateClient = weaviate.client({ - scheme: 'https', - host: 'edu-demo.weaviate.network', // Replace with your Weaviate endpoint - apiKey: new ApiKey('learn-weaviate'), // Replace with your Weaviate instance API key -}); -``` - - - - -### OIDC authentication - -import ClientAuthOIDCIntro from '/docs/weaviate/client-libraries/_components/client.auth.oidc.introduction.mdx' - - - -:::info Background refresh processes with TS -When using OIDC with the TypeScript client, its background token refresh process can block a script from exiting. If this behavior is not desired, you can: -1. Set the `silentRefresh` parameter as `false` in the OIDC configuration. Or, -1. Stop the process via `client.oidcAuth?.stopTokenRefresh()`, e.g. when a script is expected to exit, or token refresh is no longer needed. -::: - -#### Resource Owner Password Flow - -import ClientAuthFlowResourceOwnerPassword from '/docs/weaviate/client-libraries/_components/client.auth.flow.resource.owner.password.mdx' - - - - - - -```js -const { default: weaviate } = require('weaviate-ts-client'); - -const client = weaviate.client({ - scheme: 'https', - host: 'WEAVIATE_INSTANCE_URL', // Replace with your instance URL - authClientSecret: new weaviate.AuthUserPasswordCredentials({ - username: 'user123', - password: 'password', - silentRefresh: true, // Default: true - if false, you must refresh the token manually; if true, this background process will prevent a script from exiting. - scopes: ['offline_access'] // optional, depends on the configuration of your identity provider (not required with WCD) - }) -}); -``` - - - - -```ts -import weaviate, { WeaviateClient, AuthUserPasswordCredentials } from 'weaviate-ts-client'; - -const client: WeaviateClient = weaviate.client({ - scheme: 'https', - host: 'WEAVIATE_INSTANCE_URL', // Replace with your instance URL - authClientSecret: new AuthUserPasswordCredentials({ - username: 'user123', - password: 'password', - silentRefresh: true, // Default: true - if false, you must refresh the token manually; if true, this background process will prevent a script from exiting. - scopes: ['offline_access'] // optional, depends on the configuration of your identity provider (not required with WCD) - }) -}); -``` - - - - -#### Client Credentials flow - -import ClientAuthFlowClientCredentials from '/docs/weaviate/client-libraries/_components/client.auth.flow.client.credentials.mdx' - - - - - - -```js -const { default: weaviate } = require('weaviate-ts-client'); - -const client = weaviate.client({ - scheme: 'https', - host: 'WEAVIATE_INSTANCE_URL', // Replace with your instance URL - authClientSecret: new weaviate.AuthClientCredentials({ - clientSecret: 'supersecuresecret', - silentRefresh: true, // Default: true - if false, you must refresh the token manually; if true, this background process will prevent a script from exiting. - scopes: ['scope1', 'scope2'] // optional, depends on the configuration of your identity provider - }) -}); -``` - - - - -```ts -import weaviate, { WeaviateClient, AuthClientCredentials } from 'weaviate-ts-client'; - -const client: WeaviateClient = weaviate.client({ - scheme: 'https', - host: 'WEAVIATE_INSTANCE_URL', // Replace with your instance URL - authClientSecret: new AuthClientCredentials({ - clientSecret: 'supersecuresecret', - silentRefresh: true, // Default: true - if false, you must refresh the token manually; if true, this background process will prevent a script from exiting. - scopes: ['scope1', 'scope2'] // optional, depends on the configuration of your identity provider - }) -}); -``` - - - - -#### Refresh Token flow - -import ClientAuthBearerToken from '/docs/weaviate/client-libraries/_components/client.auth.bearer.token.mdx' - - - - - - -```js -const { default: weaviate } = require('weaviate-ts-client'); - -const client = weaviate.client({ - scheme: 'https', - host: 'WEAVIATE_INSTANCE_URL', // Replace with your instance URL - authClientSecret: new weaviate.AuthAccessTokenCredentials({ - accessToken: 'abcd1234', - expiresIn: 900, - refreshToken: 'efgh5678', - silentRefresh: true, // Default: true - if false, you must refresh the token manually; if true, this background process will prevent a script from exiting. - }) -}); -``` - - - - -```ts -import weaviate, { WeaviateClient, AuthAccessTokenCredentials } from 'weaviate-ts-client'; - -const client: WeaviateClient = weaviate.client({ - scheme: 'https', - host: 'WEAVIATE_INSTANCE_URL', // Replace with your instance URL - authClientSecret: new AuthAccessTokenCredentials({ - accessToken: 'abcd1234', - expiresIn: 900, - refreshToken: 'efgh5678', - silentRefresh: true, // Default: true - if false, you must refresh the token manually; if true, this background process will prevent a script from exiting. - }) -}); -``` - - - - -## Custom headers - -You can pass custom headers to the client, which are added at initialization: - - - - -```js -const { default: weaviate } = require('weaviate-ts-client'); - -const client = weaviate.client({ - scheme: 'https', - host: 'WEAVIATE_INSTANCE_URL', // Replace with your instance URL - headers: { headerName: 'HeaderValue' } -}); -``` - - - - -```ts -import weaviate, { WeaviateClient } from 'weaviate-ts-client'; - -const client: WeaviateClient = weaviate.client({ - scheme: 'https', - host: 'WEAVIATE_INSTANCE_URL', // Replace with your instance URL - headers: { headerName: 'HeaderValue' } -}); -``` - - - - -These headers will then be included in every request that the client makes. - -## References - -:::note JS to TS migration -Some older code examples are written in JavaScript and have not been updated yet. Newer code examples use TypeScript. -::: - -Our [RESTful endpoints](/weaviate/api/rest) and [GraphQL functions](/weaviate/api) covered by the TypeScript client currently have JavaScript examples in the code blocks. - -## Design - -### Builder pattern - -The TypeScript client is designed following the [Builder pattern](https://en.wikipedia.org/wiki/Builder_pattern). The pattern is used to build complex query objects. This means that calls (for example to retrieve data with a RESTful GET request, or using a more complex GraphQL query) are built with chained objects to reduce complexity. Some builder objects are optional, others are required to perform specific functions. Builder examples can be found in the [RESTful API reference pages](/weaviate/api/rest) and the [GraphQL reference pages](/weaviate/api). - -The code snippet at the top of this page shows a simple query corresponding to the RESTful request `GET /v1/schema`. The client is initialized by requiring the package and connecting to a local instance. Then, a query is constructed by getting the `.schema` with `.getter()`. The query will be sent with the `.do()` call. `do()` is required for every function you want to build and execute. - -### General notes -- All methods use ES6 Promises to deal with asynchronous code, so you need to use `.then()` after function calls, or have `async`/`await` support. -- In the case of an error, the Promise rejects with the specific error message. (If using `async`/`await`, a rejected promises acts like a thrown exception). -- Internally the client uses `isomorphic-fetch` to make the REST calls, so it should work from both the browser and NodeJS applications without any required changes. - -## TypeScript for JavaScript users - -TypeScript is a superset of JavaScript. There are, however, some differences that you should be aware of. This section offers some suggestions for JavaScript users who are new to TypeScript. - -### Run a TypeScript file - -To run a TypeScript file, first convert it to JavaScript. The `typescript` package from `npm` includes the `tsc` utility. Use `tsc` to convert (transpile) the TypeScript file. - -Install the `typescript` package. Add the `-g` flag if you want the package to be available globally. - -```bash -npm install typescript -``` - -Some packages, like the Weaviate TypeScript client, require extra configuration. The root directory of a TypeScript project has a `tsconfig.json` file. Add the following to your `tsconfig.json`. - -- Compiler options - - - `"target": "esnext"` - - `"module": "esnext"` - - `"moduleResolution": "node"` - -- `"include": ["*.ts"]` (Or specific files) -- `"lib": [ "es2018" ]` - -Don't specify filenames on the command line when you use `tsconfig.json`. Specify the TypeScript files in `tsconfig.json` instead. `tsc` only reads `tsconfig.json` when you run it by itself. - -```bash -tsc -``` - -`node` only allows the `import` statement in modules. To allow the `import` statement, add the following to your `package.json` file. - -```json -{ - "type": "module" -} -``` - -### Example - -To run this example, complete these steps. - -- Install the `typescript` package. -- Update the `tsconfig.json` and `package.json` files as described above. -- Copy the sample code. -- Save the code as `sample.ts` in the same directory as `tsconfig.json` and `package.json`. -- Convert and run the code. - -Use this code to create `sample.ts`. - -
- Sample TypeScript code - -```ts -import weaviate from 'weaviate-ts-client'; - -const client = weaviate.client({ - scheme: 'https', - host: 'edu-demo.weaviate.network', - apiKey: new weaviate.ApiKey('learn-weaviate'), -}); - -console.log(client.misc) -``` -
- -Convert `sample.ts`. - -```bash -tsc -``` - -Run the converted file. - -```bash -node sample.js -``` - -The output looks like this. - -
- Sample output - -```json -{ - "clientId": "wcs", - "href": "https://auth.wcs.api.weaviate.io/auth/realms/SeMI/.well-known/openid-configuration" -} -``` -
- -## Client releases - -
- Click here for a table of Weaviate and corresponding client versions - -import ReleaseHistory from '/_includes/release-history.md'; - - - -
- -## Client change logs - -The client [change logs](https://github.com/weaviate/typescript-client/releases) for each release are available on GitHub. - -## Questions and feedback - -import DocsFeedback from '/_includes/docs-feedback.mdx'; - - diff --git a/docs/weaviate/client-libraries/typescript/v2_v3_migration.mdx b/docs/weaviate/client-libraries/typescript/v2_v3_migration.mdx deleted file mode 100644 index 93a01d5c..00000000 --- a/docs/weaviate/client-libraries/typescript/v2_v3_migration.mdx +++ /dev/null @@ -1,457 +0,0 @@ ---- -title: Migrate from v2 to v3 -sidebar_position: 70 -description: "Upgrade guide for migrating TypeScript applications from v2 to current v3 client library version." -image: og/docs/client-libraries.jpg -# tags: ['typescript', 'client library'] ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; -import FilteredTextBlock from '@site/src/components/Documentation/FilteredTextBlock'; -import TSv2Code from '!!raw-loader!/_includes/code/client-libraries/migrate-ts2.ts'; -import TSv3Code from '!!raw-loader!/_includes/code/client-libraries/migrate-ts3.ts'; -import TSv3Additional from '!!raw-loader!/_includes/code/client-libraries/migrate-additional-ts3.ts'; -import TSv2Additional from '!!raw-loader!/_includes/code/client-libraries/migrate-additional-ts2.ts'; - -import TSClientIntro from '/_includes/clients/ts-client-intro.mdx'; - - - -## Install - -To install the TypeScript client v3, follow these steps: - -1. **Update Node.js** - - The v3 client requires `Node v18` or higher. - -1. **Install the new client package** - - ```bash - npm install weaviate-client - ``` - -1. **Upgrade Weaviate** - - The v3 client requires Weaviate Database `1.23.7` or higher. Whenever possible, use the latest versions of Weaviate Database and the Weaviate client. - -1. **Open a gRPC port** - - The default gRPC port is 50051. - -
- docker-compose.yml - - To map the Weaviate gRPC port in your Docker container to a local port, add this code to your `docker-compose.yml` file: - - ```yaml - ports: - - 8080:8080 - - 50051:50051 - ``` -
- -## Instantiate a client - -The weaviate object is the main entry point for all API operations. The v3 client instantiates the weaviate object and [creates a connection](/weaviate/connections) to your Weaviate instance. - -In most cases, you should use one of the connection helper functions to connect to your Weaviate instance: - -- `connectToWCD` -- `connectToLocal` -- `connectToCustom` - -You can also use a custom configuration to instantiate the client directly: - - - - - - - - - - - - - -## Changes in v3 - -This section highlights some features of the v3 TypeScript client. - -### Design philosophy - -The v3 client interacts with collections as the primary way to work with objects in your Weaviate database. - -Your application code creates an object that represents a collection. This object enables search and CRUD operations to be performed against it. - -This example returns objects from the `JeopardyQuestion` collection. - -```js -const myCollection = client.collections.use('JeopardyQuestion'); - -const result = await myCollection.query.fetchObjects() - -console.log(JSON.stringify(result, null, 2)); -``` - -### Node support only - -The gRPC protocol is fast and provides other internal benefits. Unfortunately, gRPC does not support browser-based client development. - -The v3 client uses gRPC to connect to your Weaviate instance. The client supports Node.js, server-based development. It does not support browser-based web client development. - -To develop a browser-based application, use the [v2 client](/weaviate/client-libraries/typescript/typescript-v2). - -### Work with collections - -The v2 client uses the `client` object for CRUD and search operations. In the v3 client, the `collection` object replaces the `client` object. - -After you create a connection, you do not have to specify the collection for each operation. This helps to reduce errors. - - - - - - - - - - -The collection object can be re-used throughout the codebase. - -### Builder Pattern is removed - -The v2 client uses builder patterns to construct queries. Builder patterns can be confusing and can lead to invalid queries. - -The v3 client doesn't use the builder pattern. The v3 client uses specific methods and method parameters instead. - - - - - - - - - - -### Batch Inserts - -The `insertMany()` method replaces `objectBatcher()` to make batch insertions easier. - -For inserts of over 5000 objects, use `insertMany()` as part of a batch process. - -For more information on batch processing, see [Batch Inserts](../../manage-objects/import.mdx). - - - - - - - - - - -### Client Close Method - -import TSClientClose from '/_includes/clients/ts-client-close.mdx'; - - - -### Filter data - -The `Filter` helper class makes it easier to use filters with conditions. The v3 client streamlines how you use `Filter` so your code is cleaner and more concise. - - - - - - - - - - -### Generate Namespace - -The v3 client adds a new namespace, `generate` for generative queries. This makes it easier to distinguish between generative queries and vector searches. - - - - - - - - - - -### Return object - -The new client has a cleaner return object. It is easier to access important information like object UUIDs, object metadata, and generative query results. - - - - - - - - - - -## Code comparison - -These samples compare v2 client code and v3 client code. - -The comparison samples omit sections of the code that are the same for both clients. The complete v2 and v3 client scripts are [here](#sample-scripts). - -### Imports - - - - - - - - - - -### Connect to Weaviate Cloud - - - - - - - - - - -### Create a collection - - - - - - - - - - -### Batch insert - - - - - - - - - - -### Query your data - - - - - - - - - - -### Delete a collection - - - - - - - - - - - -### Sample scripts - -These scripts are complete versions of the client comparison code from this section. - - - - - - - - - - -For more code examples, see the following: - -- [Search](/weaviate/search) -- [Collection management](/weaviate/manage-collections) -- [Connect to Weaviate](/weaviate/connections) - -## How to migrate your code - -To update v2 client code to v3, follow these steps: - -1. Install the [v3 client package](https://www.npmjs.com/package/weaviate-client). -1. Edit your v2 code to [import](/weaviate/client-libraries/typescript#import-the-client) the v3 client package. -1. Edit your v2 [client instantiation](/weaviate/client-libraries/typescript) code. -1. Edit your code to reflect the [collection first](#design-philosophy) client orientation. - -Continue to update the v2 code until all of the old code is replace with the v3 equivalent. - -## Client change logs - -The client [change logs](https://github.com/weaviate/typescript-client/releases) for each release are available on GitHub. - -## Questions and feedback - -import DocsFeedback from '/_includes/docs-feedback.mdx'; - - diff --git a/docs/weaviate/config-refs/collections.mdx b/docs/weaviate/config-refs/collections.mdx index ba909fbb..c681e793 100644 --- a/docs/weaviate/config-refs/collections.mdx +++ b/docs/weaviate/config-refs/collections.mdx @@ -120,7 +120,7 @@ This code example shows how to configure the collection parameters through a cli language="py" /> - @@ -129,7 +112,7 @@ To delete objects that match a set of criteria, specify the collection and a [`w - + - - - - + - - -```js -await client.batch - .objectsBatchDeleter() - .withClassName('EphemeralObject') - .withWhere({ - path: ['name'], - // highlight-start - operator: 'ContainsAny', - valueTextArray: ['asia', 'europe'], // Note the array syntax - // highlight-end - }) - // highlight-end - .do(); -``` - - @@ -287,7 +244,7 @@ The default `QUERY_MAXIMUM_RESULTS` value is 10,000. This may be configurable, e - + - - -```js -await client.batch - .objectsBatchDeleter() - .withClassName('EphemeralObject') - .withWhere({ - path: ['id'], - // highlight-start - operator: 'ContainsAny', - valueTextArray: ['12c88739-7a4e-49fd-bf53-d6a829ba0261', '3022b8be-a6dd-4ef4-b213-821f65cee53b', '30de68c1-dd53-4bed-86ea-915f34faea63'], // Note the array syntax - // highlight-end - }) - // highlight-end - .do(); -``` - - @@ -369,7 +308,7 @@ Objects must belong to a collection in Weaviate. Accordingly [deleting collectio - + - - - - + - - - The legacy Python client does not support gRPC. - + The TypeScript client v3 uses gRPC by default. @@ -186,7 +177,7 @@ Weaviate generates an UUID for each object. Object IDs must be unique. If you se - + - - - - + - - - - + - - - @@ -326,14 +293,6 @@ You can batch create links from an object to another other object through cross- language="py" /> - - - ## Python-specific considerations diff --git a/docs/weaviate/manage-objects/read-all-objects.mdx b/docs/weaviate/manage-objects/read-all-objects.mdx index f8fe75bd..f6ea27bf 100644 --- a/docs/weaviate/manage-objects/read-all-objects.mdx +++ b/docs/weaviate/manage-objects/read-all-objects.mdx @@ -11,7 +11,6 @@ import TabItem from '@theme/TabItem'; import FilteredTextBlock from '@site/src/components/Documentation/FilteredTextBlock'; import PyCode from '!!raw-loader!/_includes/code/howto/manage-data.read-all-objects.py'; import TSCode from '!!raw-loader!/_includes/code/howto/manage-data.read-all-objects.ts'; -import TSCodeLegacy from '!!raw-loader!/_includes/code/howto/manage-data.read-all-objects-v2.ts'; import JavaCode from '!!raw-loader!/_includes/code/howto/java/src/test/java/io/weaviate/docs/manage-data.read-all-objects.java'; import GoCode from '!!raw-loader!/_includes/code/howto/go/docs/manage-data.read-all-objects_test.go'; @@ -39,7 +38,7 @@ The following code iterates through all objects, providing the properties and id - + - - - - + - - - ## Read all objects - Multi-tenant collections @@ -131,7 +114,7 @@ For classes where [multi-tenancy](../concepts/data.md#multi-tenancy) is enabled, - + - - - ## Related pages diff --git a/docs/weaviate/manage-objects/read.mdx b/docs/weaviate/manage-objects/read.mdx index e72c7fcc..5f8eaf95 100644 --- a/docs/weaviate/manage-objects/read.mdx +++ b/docs/weaviate/manage-objects/read.mdx @@ -9,7 +9,6 @@ import TabItem from '@theme/TabItem'; import FilteredTextBlock from '@site/src/components/Documentation/FilteredTextBlock'; import PyCode from '!!raw-loader!/_includes/code/howto/manage-data.read.py'; import TSCode from '!!raw-loader!/_includes/code/howto/manage-data.read.ts'; -import TSCodeLegacy from '!!raw-loader!/_includes/code/howto/manage-data.read-v2.ts'; import JavaCode from '!!raw-loader!/_includes/code/howto/java/src/test/java/io/weaviate/docs/manage-data.read.java'; import GoCode from '!!raw-loader!/_includes/code/howto/go/docs/manage-data.read_test.go'; import SkipLink from '/src/components/SkipValidationLink' @@ -39,7 +38,7 @@ Use an ID to retrieve an object. If the id doesn't exist, Weaviate returns a 404 - + - - - - + - - - - + - - - diff --git a/docs/weaviate/manage-objects/update.mdx b/docs/weaviate/manage-objects/update.mdx index f7bb8954..a86476fd 100644 --- a/docs/weaviate/manage-objects/update.mdx +++ b/docs/weaviate/manage-objects/update.mdx @@ -11,7 +11,6 @@ import TabItem from '@theme/TabItem'; import FilteredTextBlock from '@site/src/components/Documentation/FilteredTextBlock'; import PyCode from '!!raw-loader!/_includes/code/howto/manage-data.update.py'; import TSCode from '!!raw-loader!/_includes/code/howto/manage-data.update.ts'; -import TSCodeLegacy from '!!raw-loader!/_includes/code/howto/manage-data.update-v2.ts'; import JavaCode from '!!raw-loader!/_includes/code/howto/java/src/test/java/io/weaviate/docs/manage-data.update.java'; import GoCode from '!!raw-loader!/_includes/code/howto/go/docs/manage-data.update_test.go'; import RestObjectsCRUDClassnameNote from '/_includes/rest-objects-crud-classname-note.md'; @@ -50,7 +49,7 @@ However, if you add a *new* property to your collection definition, Weaviate onl language="py" /> - + - - - - + - - - > Coming soon (vote for the [feature request](https://github.com/weaviate/typescript-client/issues/64)) - - @@ -141,7 +127,7 @@ The entire object can be replaced by providing the collection name, id and the n /> - + - - - - + - - - - + - + - + - + - + - + - + - + - + - + - + - + - + ```ts // TS support coming soon diff --git a/docs/weaviate/search/aggregate.md b/docs/weaviate/search/aggregate.md index 0b3acc84..98dee7ec 100644 --- a/docs/weaviate/search/aggregate.md +++ b/docs/weaviate/search/aggregate.md @@ -11,7 +11,6 @@ import FilteredTextBlock from '@site/src/components/Documentation/FilteredTextBl import PyCode from '!!raw-loader!/_includes/code/howto/search.aggregate.py'; import PyCodeV3 from '!!raw-loader!/_includes/code/howto/search.aggregate-v3.py'; import TSCode from '!!raw-loader!/_includes/code/howto/search.aggregate.ts'; -import TSCodeLegacy from '!!raw-loader!/_includes/code/howto/search.aggregate-v2.ts'; import GoCode from '!!raw-loader!/_includes/code/howto/go/docs/mainpkg/search-aggregation_test.go'; @@ -52,7 +51,7 @@ Return the number of objects matched by the query. - + - - - - + - - - - + - - - - + - - - - + - - - - + - - - - + - - - - + - - - - + - - - - - - + - - - - - + - - - - - + - - - - - - + - - - - - - + - - - - - - + - - - - - - + - - - - - - + - - - - + - - - - + - - - - + - - - - + - - - @@ -394,7 +360,7 @@ import TknTsCodeLegacy from '!!raw-loader!/\_includes/code/howto/manage-data.col - + - - - - + - - - - + - - - - + - - - - + - + - - - - + Use `Filters.and` and `Filters.or` methods to combine filters in the JS/TS `v3` API.
@@ -147,14 +139,6 @@ To filter with two or more conditions, use `And` or `Or` to define the relations /> - - - - + - - - - + - - - - + - - - - + - - - - + - - - - + - - - - + - - - - + - + - - - - + - + - - - - + - + - + - - - - + - - - - + - + - - - - + - - - - + - + - + - - - - + - - - - + - - - - + - - - - + - - - - + - - - - + - - - - + - - - - + - + - + - + - + - - - - + - - - - + - - - - + - - - > Not available yet. Vote for the [feature request](https://github.com/weaviate/typescript-client/issues/65). DIY code below. - - - @@ -122,7 +110,7 @@ You can search by a base64 representation of an image: - + - - - - + - + - + - + - + - + - + - + - - - - + - - - - + - - - - + - - - @@ -114,7 +104,7 @@ This example uses a base64 representation of an image. - + - - - - + - - - - + - - - - + - - - - + - - - - + - - - - + - - - - + - - - - + - - -
pip install -U weaviate-client ``` - + ```bash npm install weaviate-client ``` - - -```bash -npm install weaviate-ts-client -``` - ## Connect to Weaviate @@ -163,7 +156,7 @@ This [`nearVector`](/weaviate/search/similarity#search-with-a-vector) query supp language="py" /> - + - - - - + - - - @@ -111,7 +103,7 @@ Before we can generate text, we need to retrieve relevant data. Let's retrieve t language="py" /> - + - - - This should return a set of results like the following (truncated for brevity): @@ -173,7 +157,7 @@ Run the following code snippet, and inspect the results: language="py" /> - + - - - Here is our generated text: @@ -234,7 +210,7 @@ Note that in this query, we apply a `single prompt` parameter. This means that t language="py" /> - + - - - As the query was run with a limit of 5, you should see 5 objects returned, including generated texts. @@ -313,7 +281,7 @@ You can check which modules are enabled by viewing the `meta` information for yo language="py" /> - + - - - The response will include a list of modules. Check that your desired module is enabled. @@ -409,7 +369,7 @@ In the following snippet, we download a chapter of the `Pro Git` book, clean it language="py" /> - + - - - This will download the text from the chapter, and return a list/array of strings of 150 word chunks, with a 25-word overlap added in front. @@ -444,7 +396,7 @@ The below collection definition for the `GitBookChunk` collection specifies `tex language="py" /> - + - - - #### Import data @@ -475,7 +419,7 @@ Now, we can import the data into Weaviate. language="py" /> - + - - - Once this is done, you should have imported a collection of chunks from the chapter into Weaviate. You can check this by running a simple aggregation query: @@ -504,7 +440,7 @@ Once this is done, you should have imported a collection of chunks from the chap language="py" /> - + - - - Which should indicate that there are `10` chunks in the database. @@ -541,7 +469,7 @@ Single prompts tell Weaviate to generate text based on each retrieved object and language="py" /> - + - - - It should return haiku-like text, such as: @@ -588,7 +508,7 @@ In this example, we prompt the language model to write a trivia tweet based on t language="py" /> - + - - - It should return a factoid written for social media, such as: @@ -629,7 +541,7 @@ In this example, we search the chapter for passages that relate to the states of language="py" /> - + - - - This should return text like: @@ -666,7 +570,7 @@ Now, simply by changing the search query, we can generate similar content about language="py" /> - + - - - In this case, the result should be something like: diff --git a/docs/weaviate/starter-guides/managing-collections/index.mdx b/docs/weaviate/starter-guides/managing-collections/index.mdx index 66a64df6..28862ce1 100644 --- a/docs/weaviate/starter-guides/managing-collections/index.mdx +++ b/docs/weaviate/starter-guides/managing-collections/index.mdx @@ -267,7 +267,7 @@ Here's a complete example showing how to use aliases for a collection migration: language="py" /> - + - - - - - @@ -167,16 +157,6 @@ Take a look at the snippet below in which we retrieve objects from the `Jeopardy language="py" /> - - - - - @@ -207,14 +187,6 @@ Take a look at the snippet below, This query looks through the `JeopardyQuestion language="python" /> - - - - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + ' + ) + + # We'll build the new content line by line + result_lines = [] + skip_mode = False + nesting_level = 0 + + # Process the file line by line + lines = file_content.split("\n") + for line in lines: + # Check if we're starting a TypeScript Client v2 TabItem + if not skip_mode and start_pattern.search(line): + skip_mode = True + nesting_level = 1 + # Check if there's a closing tag on the same line + if "" in line: + nesting_level -= 1 + if nesting_level == 0: + skip_mode = False + continue + + # If we're in skip mode, check for nested tags + if skip_mode: + # Count opening tags (handle nested TabItems) + nesting_level += line.count("") + + # If nesting level is back to 0, we're done skipping + if nesting_level <= 0: + skip_mode = False + continue + + # If we're not skipping, add the line to the result + result_lines.append(line) + + return "\n".join(result_lines) + + +def process_directory(directory_path, file_extensions, dry_run=True): + """ + Process all files with given extensions in a directory and its subdirectories. + """ + directory = Path(directory_path) + files_processed = 0 + files_modified = 0 + + for ext in file_extensions: + for file_path in directory.glob(f"**/*{ext}"): + files_processed += 1 + + # Read the file content + with open(file_path, "r", encoding="utf-8") as file: + try: + content = file.read() + except UnicodeDecodeError: + print(f"Error reading {file_path}: UnicodeDecodeError") + continue + + # Process the content + new_content = remove_ts2_tab_items(content) + + # If content was modified + if new_content != content: + files_modified += 1 + print(f"Modified: {file_path}") + + # Write the changes if not in dry-run mode + if not dry_run: + with open(file_path, "w", encoding="utf-8") as file: + file.write(new_content) + + return files_processed, files_modified + + +def main(): + parser = argparse.ArgumentParser( + description="Remove TypeScript Client v2 TabItem blocks from files." + ) + parser.add_argument("directory", help="Directory to process") + parser.add_argument( + "--ext", + nargs="+", + default=[".md", ".mdx"], + help="File extensions to process (default: .md .mdx)", + ) + parser.add_argument( + "--apply", + action="store_true", + help="Apply changes (without this flag, runs in dry-run mode)", + ) + + args = parser.parse_args() + + print(f"Processing files in {args.directory}") + print(f"File extensions: {', '.join(args.ext)}") + print( + f"Mode: {'Apply Changes' if args.apply else 'Dry Run (no changes will be made)'}" + ) + + files_processed, files_modified = process_directory( + args.directory, args.ext, dry_run=not args.apply + ) + + print(f"\nSummary:") + print(f"Files processed: {files_processed}") + print(f"Files that would be modified: {files_modified}") + + if not args.apply and files_modified > 0: + print("\nRun with --apply to make the changes.") + + +if __name__ == "__main__": + main()