关键词搜索

关键词搜索，也称为“BM25（最佳匹配25）”或“稀疏向量”搜索，返回具有最高 BM25F 分数的对象。

您更喜欢自然语言查询吗？

查询代理将简单的英文问题自动转换为优化的 Weaviate 查询 - 无需手动构建查询。

仅云端

基本的 BM25 搜索

要使用 BM25 关键词搜索，请定义一个搜索字符串。

PythonJavaScript/TypeScriptGoJava v6Java v5 (已弃用)C#GraphQL

  API 文档

更多信息文档中的代码片段反映了最新的客户端库和 Weaviate 数据库版本。请查看 发行说明 以获取特定版本。

如果某个片段无法工作或您有任何反馈，请打开一个 GitHub issue。

jeopardy = client.collections.use("JeopardyQuestion")
response = jeopardy.query.bm25(
    query="food",
    limit=3
)

for o in response.objects:
    print(o.properties)

const jeopardy = client.collections.use('JeopardyQuestion');

const result = await jeopardy.query.bm25('food', {
  limit: 3,
})

for (let object of result.objects) {
  console.log(JSON.stringify(object.properties, null, 2));
}

ctx := context.Background()
className := "JeopardyQuestion"
query := (&graphql.BM25ArgumentBuilder{}).WithQuery("food")
limit := int(3)

result, err := client.GraphQL().Get().
  WithClassName(className).
  WithFields(
  	graphql.Field{Name: "question"},
  	graphql.Field{Name: "answer"},
  ).
  WithBM25(query).
  WithLimit(limit).
  Do(ctx)

CollectionHandle<Map<String, Object>> jeopardy =
    client.collections.use("JeopardyQuestion");
var response = jeopardy.query.bm25(
    "food",
    q -> q.limit(3));

for (var o : response.objects()) {
  System.out.println(o.properties());
}

Bm25Argument keyword = Bm25Argument.builder()
  .query("food")
  .build();

Fields fields = Fields.builder()
  .fields(new Field[]{
    Field.builder().name("question").build(),
    Field.builder().name("answer").build(),
  })
  .build();

String query = GetBuilder.builder()
  .className("JeopardyQuestion")
  .fields(fields)
  .withBm25Filter(keyword)
  .limit(3)
  .build()
  .buildQuery();

Result<GraphQLResponse> result = client.graphQL().raw().withQuery(query).run();

var jeopardy = client.Collections.Use("JeopardyQuestion");
var response = await jeopardy.Query.BM25(
    "food",
    limit: 3
);

foreach (var o in response.Objects)
{
    Console.WriteLine(JsonSerializer.Serialize(o.Properties));
}

{
  Get {
    JeopardyQuestion(
      limit: 3
      bm25: {
        query: "food"
      }
    ) {
      question
      answer
    }
  }
}

示例响应

响应如下

{
  "data": {
    "Get": {
      "JeopardyQuestion": [
        {
          "answer": "food stores (supermarkets)",
          "question": "This type of retail store sells more shampoo & makeup than any other"
        },
        {
          "answer": "cake",
          "question": "Devil's food & angel food are types of this dessert"
        },
        {
          "answer": "a closer grocer",
          "question": "A nearer food merchant"
        }
      ]
    }
  }
}

搜索运算符

在 v1.31 中添加

搜索运算符定义了查询 词元中必须存在于对象中才能返回的最小数量。选项是 and 或 or（默认）。

or

使用 or 运算符，搜索将返回包含搜索字符串中的至少 minimumOrTokensMatch 个词元的对象。

PythonJava v6C#GraphQL

  API 文档

更多信息文档中的代码片段反映了最新的客户端库和 Weaviate 数据库版本。请查看 发行说明 以获取特定版本。

如果某个片段无法工作或您有任何反馈，请打开一个 GitHub issue。

from weaviate.classes.query import BM25Operator

jeopardy = client.collections.use("JeopardyQuestion")
response = jeopardy.query.bm25(
    query="Australian mammal cute",
    operator=BM25Operator.or_(minimum_match=1),
    limit=3,
)

for o in response.objects:
    print(o.properties)

var jeopardy = client.Collections.Use("JeopardyQuestion");
var response = await jeopardy.Query.BM25(
    query: "Australian mammal cute",
    searchOperator: new BM25Operator.Or(MinimumMatch: 1),
    limit: 3
);

foreach (var o in response.Objects)
{
    Console.WriteLine(JsonSerializer.Serialize(o.Properties));
}

{
  Get {
    JeopardyQuestion(
      limit: 3
      bm25: {
        query: "Australian mammal cute"
        searchOperator: {
          operator: Or,
          minimumOrTokensMatch: 2
        }
      }
    ) {
      question
      answer
    }
  }
}

and

使用 and 运算符，搜索将返回包含搜索字符串中所有词元的对象。

PythonJava v6C#GraphQL

  API 文档

更多信息文档中的代码片段反映了最新的客户端库和 Weaviate 数据库版本。请查看 发行说明 以获取特定版本。

如果某个片段无法工作或您有任何反馈，请打开一个 GitHub issue。

from weaviate.classes.query import BM25Operator

jeopardy = client.collections.use("JeopardyQuestion")
response = jeopardy.query.bm25(
    query="Australian mammal cute",
    operator=BM25Operator.and_(),  # Each result must include all tokens (e.g. "australian", "mammal", "cute")
    limit=3,
)

for o in response.objects:
    print(o.properties)

var jeopardy = client.Collections.Use("JeopardyQuestion");
var response = await jeopardy.Query.BM25(
    query: "Australian mammal cute",
    searchOperator: new BM25Operator.And(), // Each result must include all tokens (e.g. "australian", "mammal", "cute")
    limit: 3
);

foreach (var o in response.Objects)
{
    Console.WriteLine(JsonSerializer.Serialize(o.Properties));
}

{
  Get {
    JeopardyQuestion(
      limit: 3
      bm25: {
        query: "Australian mammal cute"
        searchOperator: {
          operator: And,
        }
      }
    ) {
      question
      answer
    }
  }
}

检索 BM25F 分数

您可以检索每个返回对象的 BM25F score 值。

PythonJavaScript/TypeScriptGoJava v6Java v5 (已弃用)C#GraphQL

  API 文档

更多信息文档中的代码片段反映了最新的客户端库和 Weaviate 数据库版本。请查看 发行说明 以获取特定版本。

如果某个片段无法工作或您有任何反馈，请打开一个 GitHub issue。

from weaviate.classes.query import MetadataQuery

jeopardy = client.collections.use("JeopardyQuestion")
response = jeopardy.query.bm25(
    query="food",
    return_metadata=MetadataQuery(score=True),
    limit=3
)

for o in response.objects:
    print(o.properties)
    print(o.metadata.score)

const jeopardy = client.collections.use('JeopardyQuestion');

const result = await jeopardy.query.bm25('food', {
  returnMetadata: ['score'],
  limit: 3
})

for (let object of result.objects) {
  console.log(JSON.stringify(object.properties, null, 2));
  console.log(object.metadata?.score);
}

ctx := context.Background()
className := "JeopardyQuestion"
query := (&graphql.BM25ArgumentBuilder{}).WithQuery("food")
limit := int(3)

result, err := client.GraphQL().Get().
  WithClassName(className).
  WithFields(
  	graphql.Field{Name: "question"},
  	graphql.Field{Name: "answer"},
  	graphql.Field{
  		Name: "_additional",
  		Fields: []graphql.Field{
  			{Name: "score"},
  		},
  	},
  ).
  WithBM25(query).
  WithLimit(limit).
  Do(ctx)

CollectionHandle<Map<String, Object>> jeopardy =
    client.collections.use("JeopardyQuestion");
var response = jeopardy.query.bm25("food",
    q -> q.returnMetadata(Metadata.SCORE).limit(3));

for (var o : response.objects()) {
  System.out.println(o.properties());
  System.out.println(o.queryMetadata().score());
}

Bm25Argument keyword = Bm25Argument.builder()
  .query("food")
  .build();

Fields fields = Fields.builder()
  .fields(new Field[]{
    Field.builder().name("question").build(),
    Field.builder().name("answer").build(),
    Field.builder().name("_additional").fields(new Field[]{
      Field.builder().name("score").build()
    }).build()
  })
  .build();

String query = GetBuilder.builder()
  .className("JeopardyQuestion")
  .fields(fields)
  .withBm25Filter(keyword)
  .limit(3)
  .build()
  .buildQuery();

Result<GraphQLResponse> result = client.graphQL().raw().withQuery(query).run();

var jeopardy = client.Collections.Use("JeopardyQuestion");
var response = await jeopardy.Query.BM25(
    "food",
    returnMetadata: MetadataOptions.Score,
    limit: 3
);

foreach (var o in response.Objects)
{
    Console.WriteLine(JsonSerializer.Serialize(o.Properties));
    Console.WriteLine(o.Metadata.Score);
}

{
  Get {
    JeopardyQuestion(
      limit: 3
      bm25: {
        query: "food"
      }
    ) {
      question
      answer
      _additional {
        score
      }
    }
  }
}

示例响应

响应如下

{
  "data": {
    "Get": {
      "JeopardyQuestion": [
        {
          "_additional": {
            "score": "3.0140665"
          },
          "answer": "food stores (supermarkets)",
          "question": "This type of retail store sells more shampoo & makeup than any other"
        },
        {
          "_additional": {
            "score": "2.8725255"
          },
          "answer": "cake",
          "question": "Devil's food & angel food are types of this dessert"
        },
        {
          "_additional": {
            "score": "2.7672548"
          },
          "answer": "a closer grocer",
          "question": "A nearer food merchant"
        }
      ]
    }
  }
}

仅在选定的属性上搜索

关键词搜索可以定向到仅搜索对象属性的子集。在此示例中，BM25 搜索仅使用 question 属性来生成 BM25F 分数。

PythonJavaScript/TypeScriptGoJava v6Java v5 (已弃用)C#GraphQL

  API 文档

更多信息文档中的代码片段反映了最新的客户端库和 Weaviate 数据库版本。请查看 发行说明 以获取特定版本。

如果某个片段无法工作或您有任何反馈，请打开一个 GitHub issue。

from weaviate.classes.query import MetadataQuery

jeopardy = client.collections.use("JeopardyQuestion")
response = jeopardy.query.bm25(
    query="safety",
    query_properties=["question"],
    return_metadata=MetadataQuery(score=True),
    limit=3
)

for o in response.objects:
    print(o.properties)
    print(o.metadata.score)

const jeopardy = client.collections.use('JeopardyQuestion');

const result = await jeopardy.query.bm25('safety', {
  queryProperties: ['question'],
  returnMetadata: ['score'],
  limit: 3
})

for (let object of result.objects) {
  console.log(JSON.stringify(object.properties, null, 2));
  console.log(object.metadata?.score);
}

ctx := context.Background()
className := "JeopardyQuestion"
query := (&graphql.BM25ArgumentBuilder{}).WithQuery("safety").WithProperties("question")
limit := int(3)

result, err := client.GraphQL().Get().
  WithClassName(className).
  WithFields(
  	graphql.Field{Name: "question"},
  	graphql.Field{
  		Name: "_additional",
  		Fields: []graphql.Field{
  			{Name: "score"},
  		},
  	},
  ).
  WithBM25(query).
  WithLimit(limit).
  Do(ctx)

CollectionHandle<Map<String, Object>> jeopardy =
    client.collections.use("JeopardyQuestion");
var response = jeopardy.query.bm25("safety", q -> q
    .queryProperties("question")
    .returnMetadata(Metadata.SCORE)
    .limit(3));

for (var o : response.objects()) {
  System.out.println(o.properties());
  System.out.println(o.queryMetadata().score());
}

Bm25Argument keyword = Bm25Argument.builder()
  .query("food")
  .properties(new String[]{ "question" })
  .build();

Fields fields = Fields.builder()
  .fields(new Field[]{
    Field.builder().name("question").build(),
    Field.builder().name("answer").build(),
    Field.builder().name("_additional").fields(new Field[]{
      Field.builder().name("score").build()
    }).build()
  })
  .build();

String query = GetBuilder.builder()
  .className("JeopardyQuestion")
  .fields(fields)
  .withBm25Filter(keyword)
  .limit(3)
  .build()
  .buildQuery();

Result<GraphQLResponse> result = client.graphQL().raw().withQuery(query).run();

var jeopardy = client.Collections.Use("JeopardyQuestion");
var response = await jeopardy.Query.BM25(
    "safety",
    searchFields: ["question"],
    returnMetadata: MetadataOptions.Score,
    limit: 3
);

foreach (var o in response.Objects)
{
    Console.WriteLine(JsonSerializer.Serialize(o.Properties));
    Console.WriteLine(o.Metadata.Score);
}

{
  Get {
    JeopardyQuestion(
      limit: 3
      bm25: {
        query: "food"
        properties: ["question"]
      }
    ) {
      question
      answer
      _additional {
        score
      }
    }
  }
}

示例响应

响应如下

{
  "data": {
    "Get": {
      "JeopardyQuestion": [
        {
          "_additional": {
            "score": "3.7079012"
          },
          "answer": "cake",
          "question": "Devil's food & angel food are types of this dessert"
        },
        {
          "_additional": {
            "score": "3.4311616"
          },
          "answer": "a closer grocer",
          "question": "A nearer food merchant"
        },
        {
          "_additional": {
            "score": "2.8312314"
          },
          "answer": "honey",
          "question": "The primary source of this food is the Apis mellifera"
        }
      ]
    }
  }
}

使用权重来提升属性

您可以设置每个属性对整体 BM25F 分数的影响权重。此示例将 question 属性的权重提高 2 倍，而 answer 属性保持静态。

PythonJavaScript/TypeScriptGoJava v6Java v5 (已弃用)C#GraphQL

  API 文档

更多信息文档中的代码片段反映了最新的客户端库和 Weaviate 数据库版本。请查看 发行说明 以获取特定版本。

如果某个片段无法工作或您有任何反馈，请打开一个 GitHub issue。

jeopardy = client.collections.use("JeopardyQuestion")
response = jeopardy.query.bm25(
    query="food",
    query_properties=["question^2", "answer"],
    limit=3
)

for o in response.objects:
    print(o.properties)

const jeopardy = client.collections.use('JeopardyQuestion');

const result = await jeopardy.query.bm25('food', {
  queryProperties: ['question^2', 'answer'],
  returnMetadata: ['score'],
  limit: 3
})

for (let object of result.objects) {
  console.log(JSON.stringify(object.properties, null, 2));
  console.log(object.metadata?.score);
}

ctx := context.Background()
className := "JeopardyQuestion"
query := (&graphql.BM25ArgumentBuilder{}).WithQuery("food").WithProperties("question^2", "answer")
limit := int(3)

result, err := client.GraphQL().Get().
  WithClassName(className).
  WithFields(
  	graphql.Field{Name: "question"},
  	graphql.Field{Name: "answer"},
  ).
  WithBM25(query).
  WithLimit(limit).
  Do(ctx)

CollectionHandle<Map<String, Object>> jeopardy =
    client.collections.use("JeopardyQuestion");
var response = jeopardy.query.bm25("food", q -> q
    .queryProperties("question^2", "answer")
    .limit(3));

for (var o : response.objects()) {
  System.out.println(o.properties());
}

Bm25Argument keyword = Bm25Argument.builder()
  .query("food")
  .properties(new String[]{ "question^2", "answer" })
  .build();

Fields fields = Fields.builder()
  .fields(new Field[]{
    Field.builder().name("question").build(),
    Field.builder().name("answer").build(),
    Field.builder().name("_additional").fields(new Field[]{
      Field.builder().name("score").build()
    }).build()
  })
  .build();

String query = GetBuilder.builder()
  .className("JeopardyQuestion")
  .fields(fields)
  .withBm25Filter(keyword)
  .limit(3)
  .build()
  .buildQuery();

Result<GraphQLResponse> result = client.graphQL().raw().withQuery(query).run();

var jeopardy = client.Collections.Use("JeopardyQuestion");
var response = await jeopardy.Query.BM25(
    "food",
    searchFields: ["question^2", "answer"],
    limit: 3
);

foreach (var o in response.Objects)
{
    Console.WriteLine(JsonSerializer.Serialize(o.Properties));
}

{
  Get {
    JeopardyQuestion(
      limit: 3
      bm25: {
        query: "food"
        properties: ["question^2", "answer"]
      }
    ) {
      question
      answer
      _additional {
        score
      }
    }
  }
}

示例响应

响应如下

{
  "data": {
    "Get": {
      "JeopardyQuestion": [
        {
          "_additional": {
            "score": "4.0038033"
          },
          "answer": "cake",
          "question": "Devil's food & angel food are types of this dessert"
        },
        {
          "_additional": {
            "score": "3.8706005"
          },
          "answer": "a closer grocer",
          "question": "A nearer food merchant"
        },
        {
          "_additional": {
            "score": "3.2457707"
          },
          "answer": "food stores (supermarkets)",
          "question": "This type of retail store sells more shampoo & makeup than any other"
        }
      ]
    }
  }
}

设置词元化

BM25 查询字符串在用于使用倒排索引搜索对象之前会被 词元化。

您必须在集合定义中为 每个属性指定词元化方法。

PythonJavaScript/TypeScriptJava v6Java v5 (已弃用)C#

  API 文档

更多信息文档中的代码片段反映了最新的客户端库和 Weaviate 数据库版本。请查看 发行说明 以获取特定版本。

如果某个片段无法工作或您有任何反馈，请打开一个 GitHub issue。

from weaviate.classes.config import Configure, Property, DataType, Tokenization

client.collections.create(
    "Article",
    vector_config=Configure.Vectors.text2vec_cohere(),
    properties=[
        Property(
            name="title",
            data_type=DataType.TEXT,
            vectorize_property_name=True,  # Use "title" as part of the value to vectorize
            tokenization=Tokenization.LOWERCASE,  # Use "lowercase" tokenization
            description="The title of the article.",  # Optional description
        ),
        Property(
            name="body",
            data_type=DataType.TEXT,
            skip_vectorization=True,  # Don't vectorize this property
            tokenization=Tokenization.WHITESPACE,  # Use "whitespace" tokenization
        ),
    ],
)

import { vectors, dataType, tokenization } from 'weaviate-client';

  const newCollection = await client.collections.create({
    name: 'Article',
    vectorizers: vectors.text2VecHuggingFace(),
    properties: [
      {
        name: 'title',
        dataType: dataType.TEXT,
        vectorizePropertyName: true,
        tokenization: tokenization.LOWERCASE // or 'lowercase'
      },
      {
        name: 'body',
        dataType: dataType.TEXT,
        skipVectorization: true,
        tokenization: tokenization.WHITESPACE // or 'whitespace'
      },
    ],
  })

client.collections.create("Article",
    col -> col.properties(
        Property.text("title",
            p -> p.description("The title of the article.")
                .tokenization(Tokenization.LOWERCASE)
                .vectorizePropertyName(false)),
        Property.text("body", p -> p.skipVectorization(true)
            .tokenization(Tokenization.WHITESPACE))));

Property titleProperty = Property.builder()
  .name("title")
  .description("title of the article")
  .dataType(Arrays.asList(DataType.TEXT))
  .tokenization(Tokenization.LOWERCASE)
  .build();

Property bodyProperty = Property.builder()
  .name("body")
  .description("body of the article")
  .dataType(Arrays.asList(DataType.TEXT))
  .tokenization(Tokenization.WHITESPACE)
  .build();

//Add the defined properties to the class
WeaviateClass articleClass = WeaviateClass.builder()
  .className("Article")
  .description("Article Class Description...")
  .properties(Arrays.asList(titleProperty, bodyProperty))
  .build();

Result<Boolean> result = client.schema().classCreator()
  .withClass(articleClass)
  .run();

词元化和模糊匹配

为了实现模糊匹配和容错，请使用 trigram 词元化。有关详细信息，请参阅上面的 模糊匹配部分。

limit & offset

使用 limit 设置要返回的对象的固定最大数量。

可选地，使用 offset 对结果进行分页。

PythonJavaScript/TypeScriptGoJava v6Java v5 (已弃用)C#GraphQL

  API 文档

更多信息文档中的代码片段反映了最新的客户端库和 Weaviate 数据库版本。请查看 发行说明 以获取特定版本。

如果某个片段无法工作或您有任何反馈，请打开一个 GitHub issue。

jeopardy = client.collections.use("JeopardyQuestion")
response = jeopardy.query.bm25(
    query="safety",
    limit=3,
    offset=1
)

for o in response.objects:
    print(o.properties)

const jeopardy = client.collections.use('JeopardyQuestion');

const result = await jeopardy.query.bm25('safety', {
  limit: 3,
  offset: 1
})

for (let object of result.objects) {
  console.log(JSON.stringify(object.properties, null, 2));
}

ctx := context.Background()
className := "JeopardyQuestion"
query := (&graphql.BM25ArgumentBuilder{}).WithQuery("safety")
limit := int(3)
offset := int(1)

result, err := client.GraphQL().Get().
  WithClassName(className).
  WithFields(
  	graphql.Field{Name: "question"},
  	graphql.Field{Name: "answer"},
  ).
  WithBM25(query).
  WithLimit(limit).
  WithOffset(offset).
  Do(ctx)

CollectionHandle<Map<String, Object>> jeopardy =
    client.collections.use("JeopardyQuestion");
var response = jeopardy.query.bm25("safety", q -> q
    .limit(3)
    .offset(1)
);

for (var o : response.objects()) {
  System.out.println(o.properties());
}

Bm25Argument keyword = Bm25Argument.builder()
  .query("safety")
  .build();

Fields fields = Fields.builder()
  .fields(new Field[]{
    Field.builder().name("question").build(),
    Field.builder().name("answer").build(),
  })
  .build();

String query = GetBuilder.builder()
  .className("JeopardyQuestion")
  .fields(fields)
  .withBm25Filter(keyword)
  .limit(3)
  .offset(1)
  .build()
  .buildQuery();

Result<GraphQLResponse> result = client.graphQL().raw().withQuery(query).run();

var jeopardy = client.Collections.Use("JeopardyQuestion");
var response = await jeopardy.Query.BM25(
    "safety",
    limit: 3,
    offset: 1
);

foreach (var o in response.Objects)
{
    Console.WriteLine(JsonSerializer.Serialize(o.Properties));
}

{
  Get {
    JeopardyQuestion(
      bm25: {
        query: "safety"
      }
      limit: 3
    ) {
      question
      answer
      _additional {
        score
      }
    }
  }
}

限制结果组

要将结果限制为与查询相似距离的组，请使用 autocut 过滤器来设置要返回的组数。

PythonJavaScript/TypeScriptGoJava v6Java v5 (已弃用)C#GraphQL

  API 文档

更多信息文档中的代码片段反映了最新的客户端库和 Weaviate 数据库版本。请查看 发行说明 以获取特定版本。

如果某个片段无法工作或您有任何反馈，请打开一个 GitHub issue。

jeopardy = client.collections.use("JeopardyQuestion")
response = jeopardy.query.bm25(
    query="safety",
    auto_limit=1
)

for o in response.objects:
    print(o.properties)

const jeopardy = client.collections.use('JeopardyQuestion');

const result = await jeopardy.query.bm25('safety', {
  autoLimit: 1,
})

for (let object of result.objects) {
  console.log(JSON.stringify(object.properties, null, 2));
}

ctx := context.Background()
className := "JeopardyQuestion"
query := (&graphql.BM25ArgumentBuilder{}).WithQuery("safety")
autoLimit := int(1)

result, err := client.GraphQL().Get().
  WithClassName(className).
  WithFields(
  	graphql.Field{Name: "question"},
  	graphql.Field{Name: "answer"},
  ).
  WithBM25(query).
  WithAutocut(autoLimit).
  Do(ctx)

Bm25Argument keyword = Bm25Argument.builder()
  .query("safety")
  .build();

Fields fields = Fields.builder()
  .fields(new Field[]{
    Field.builder().name("question").build(),
    Field.builder().name("answer").build(),
  })
  .build();

String query = GetBuilder.builder()
  .className("JeopardyQuestion")
  .fields(fields)
  .withBm25Filter(keyword)
  .autocut(1)
  .build()
  .buildQuery();

Result<GraphQLResponse> result = client.graphQL().raw().withQuery(query).run();

var jeopardy = client.Collections.Use("JeopardyQuestion");
var response = await jeopardy.Query.BM25(
    "safety",
    autoLimit: 1
);

foreach (var o in response.Objects)
{
    Console.WriteLine(JsonSerializer.Serialize(o.Properties));
}

{
  Get {
    JeopardyQuestion(
      bm25: {
        query: "safety"
      }
      autocut: 1
    ) {
      question
      answer
      _additional {
        score
      }
    }
  }
}

示例响应

响应如下

{
  "data": {
    "Get": {
      "JeopardyQuestion": [
        {
          "_additional": {
            "score": "2.6768136"
          },
          "answer": "OSHA (Occupational Safety and Health Administration)",
          "question": "The government admin. was created in 1971 to ensure occupational health & safety standards"
        }
      ]
    }
  }
}

分组结果

添加到 v1.25

定义标准以对搜索结果进行分组。

PythonJavaScript/TypeScriptJava v6Java v5 (已弃用)C#

  API 文档

更多信息文档中的代码片段反映了最新的客户端库和 Weaviate 数据库版本。请查看 发行说明 以获取特定版本。

如果某个片段无法工作或您有任何反馈，请打开一个 GitHub issue。

from weaviate.classes.query import GroupBy

jeopardy = client.collections.use("JeopardyQuestion")

# Grouping parameters
group_by = GroupBy(
    prop="round",  # group by this property
    objects_per_group=3,  # maximum objects per group
    number_of_groups=2,  # maximum number of groups
)

# Query
response = jeopardy.query.bm25(
    query="California",
    group_by=group_by
)

for grp_name, grp_content in response.groups.items():
    print(grp_name, grp_content.objects)

const jeopardy = client.collections.use('JeopardyQuestion');

// Grouping parameters
const groupByProperties = {
  property: "round", // group by this property
  objectsPerGroup: 3, // maximum objects per group
  numberOfGroups: 2 // maximum number of groups
}

// Query
const response = await jeopardy.query.bm25("California", {
    groupBy: groupByProperties
})

for (let groupName in response.groups) {
  console.log(groupName)
  // Uncomment to view group objects 
  // console.log(response.groups[groupName].objects)
}

CollectionHandle<Map<String, Object>> jeopardy =
    client.collections.use("JeopardyQuestion");

var response = jeopardy.query.bm25("California", q -> q, // No query options needed for this example
    GroupBy.property("round", // group by this property
        2, // maximum number of groups
        3 // maximum objects per group
    ));

response.groups().forEach((groupName, group) -> {
  System.out.println(group.name() + " " + group.objects());
});

Bm25Argument keyword = Bm25Argument.builder()
  .query("California")
  .build();

Fields fields = Fields.builder()
  .fields(new Field[]{
    Field.builder().name("round").build()
  })
  .build();

GroupByArgument groupBy = GroupByArgument.builder()
  .path(new String[]{ "round" })
  .groups(1)
  .objectsPerGroup(3)
  .build();

String query = GetBuilder.builder()
  .className("JeopardyQuestion")
  .fields(fields)
  .withBm25Filter(keyword)
  .withGroupByArgument(groupBy)
  .build()
  .buildQuery();

Result<GraphQLResponse> result = client.graphQL().raw().withQuery(query).run();

var jeopardy = client.Collections.Use("JeopardyQuestion");

var response = await jeopardy.Query.BM25(
    "California",
    groupBy: new GroupByRequest("round") // group by this property
    {
        NumberOfGroups = 2, // maximum number of groups
        ObjectsPerGroup = 3, // maximum objects per group
    }
);

foreach (var group in response.Groups.Values)
{
    Console.WriteLine($"{group.Name} {JsonSerializer.Serialize(group.Objects)}");
}

示例响应

响应如下

'Jeopardy!'
'Double Jeopardy!'

过滤结果

为了获得更具体的结果，请使用 filter 来缩小搜索范围。

PythonJavaScript/TypeScriptGoJava v6Java v5 (已弃用)C#GraphQL

  API 文档

更多信息文档中的代码片段反映了最新的客户端库和 Weaviate 数据库版本。请查看 发行说明 以获取特定版本。

如果某个片段无法工作或您有任何反馈，请打开一个 GitHub issue。

from weaviate.classes.query import Filter

jeopardy = client.collections.use("JeopardyQuestion")
response = jeopardy.query.bm25(
    query="food",
    filters=Filter.by_property("round").equal("Double Jeopardy!"),
    return_properties=["answer", "question", "round"], # return these properties
    limit=3
)

for o in response.objects:
    print(o.properties)

const jeopardy = client.collections.use('JeopardyQuestion');

const result = await jeopardy.query.bm25('food', {
  limit: 3,
  returnMetadata: ['score'],
  filters: jeopardy.filter.byProperty('round').equal('Double Jeopardy!'),
  returnProperties: ['question', 'answer', 'round'],
})

for (let object of result.objects) {
  console.log(JSON.stringify(object.properties, null, 2));
}

ctx := context.Background()
className := "JeopardyQuestion"

query := (&graphql.BM25ArgumentBuilder{}).WithQuery("food")
limit := int(3)

filter := filters.Where().
  WithPath([]string{"round"}).
  WithOperator(filters.Equal).
  WithValueString("Double Jeopardy!")

result, err := client.GraphQL().Get().
  WithClassName(className).
  WithFields(
  	graphql.Field{Name: "answer"},
  	graphql.Field{Name: "question"},
  	graphql.Field{Name: "round"},
  ).
  WithBM25(query).
  WithWhere(filter).
  WithLimit(limit).
  Do(ctx)

CollectionHandle<Map<String, Object>> jeopardy =
    client.collections.use("JeopardyQuestion");
var response = jeopardy.query.bm25("food", q -> q
    .filters(Filter.property("round").eq("Double Jeopardy!"))
    .returnProperties("answer", "question", "round") // return these properties
    .limit(3));

for (var o : response.objects()) {
  System.out.println(o.properties());
}

Bm25Argument keyword = Bm25Argument.builder()
  .query("food")
  .build();

Fields fields = Fields.builder()
  .fields(new Field[]{
    Field.builder().name("question").build(),
    Field.builder().name("answer").build(),
    Field.builder().name("round").build(),
    Field.builder().name("_additional").fields(new Field[]{
      Field.builder().name("score").build()
    }).build()
  })
  .build();

WhereFilter whereFilter = WhereFilter.builder()
  .path(new String[]{ "round" })  // Path to filter by
  .operator(Operator.Equal)
  .valueText("Double Jeopardy!")
  .build();

WhereArgument whereArgument = WhereArgument.builder()
  .filter(whereFilter)
  .build();

String query = GetBuilder.builder()
  .className("JeopardyQuestion")
  .fields(fields)
  .withBm25Filter(keyword)
  .withWhereFilter(whereArgument)
  .limit(3)
  .build()
  .buildQuery();

Result<GraphQLResponse> result = client.graphQL().raw().withQuery(query).run();

var jeopardy = client.Collections.Use("JeopardyQuestion");
var response = await jeopardy.Query.BM25(
    "food",
    filters: Filter.Property("round").IsEqual("Double Jeopardy!"),
    returnProperties: ["answer", "question", "round"], // return these properties
    limit: 3
);

foreach (var o in response.Objects)
{
    Console.WriteLine(JsonSerializer.Serialize(o.Properties));
}

{
  Get {
    JeopardyQuestion(
      limit: 3
      bm25: {
        query: "food"
      }
      where: {
        path: ["round"]
        operator: Equal
        valueText: "Double Jeopardy!"
      }
    ) {
      question
      answer
      _additional {
        score
      }
    }
  }
}

示例响应

响应如下

{
  "data": {
    "Get": {
      "JeopardyQuestion": [
        {
          "_additional": {
            "score": "3.0140665"
          },
          "answer": "food stores (supermarkets)",
          "question": "This type of retail store sells more shampoo & makeup than any other",
          "round": "Double Jeopardy!"
        },
        {
          "_additional": {
            "score": "1.9633813"
          },
          "answer": "honey",
          "question": "The primary source of this food is the Apis mellifera",
          "round": "Double Jeopardy!"
        },
        {
          "_additional": {
            "score": "1.6719631"
          },
          "answer": "pseudopods",
          "question": "Amoebas use temporary extensions called these to move or to surround & engulf food",
          "round": "Double Jeopardy!"
        }
      ]
    }
  }
}

词元化

Weaviate 将过滤器术语转换为词元。默认词元化是 word。word 词元化器保留字母数字字符，将它们转换为小写，并在空格处拆分。它将字符串 "Test_domain_weaviate" 转换为 "test"、"domain" 和 "weaviate"。

有关详细信息和附加词元化方法，请参阅词元化。

模糊匹配

您可以通过使用 trigram 词元化 在 BM25 搜索中启用模糊匹配和容错。此技术将文本分解为重叠的 3 个字符序列，即使存在拼写错误或变化，BM25 也能找到匹配项。

这使得在它们共享许多三元组的情况下，匹配相似但不相同的字符串成为可能

• "Morgn" 和 "Morgan" 共享诸如 "org", "rga", "gan" 之类的三元组

在创建集合时，将词元化方法设置为 trigram

PythonJavaScript/TypeScriptJava v6C#

  API 文档

更多信息文档中的代码片段反映了最新的客户端库和 Weaviate 数据库版本。请查看 发行说明 以获取特定版本。

如果某个片段无法工作或您有任何反馈，请打开一个 GitHub issue。

from weaviate.classes.config import Configure, Property, DataType, Tokenization

client.collections.create(
    "Article",
    vector_config=Configure.Vectors.text2vec_cohere(),
    properties=[
        Property(
            name="title",
            data_type=DataType.TEXT,
            tokenization=Tokenization.TRIGRAM,  # Use "trigram" tokenization
        ),
    ],
)

import { vectors, dataType, tokenization } from 'weaviate-client';

  const newCollection = await client.collections.create({
    name: 'Article',
    vectorizers: vectors.text2VecHuggingFace(),
    properties: [
      {
        name: 'title',
        dataType: dataType.TEXT,
        tokenization: tokenization.TRIGRAM  // Use "trigram" tokenization
      },
    ],
  })

client.collections.create("Article", col -> col
    .vectorConfig(VectorConfig.text2vecTransformers())
    .properties(
        Property.text("title", p -> p.tokenization(Tokenization.TRIGRAM))));

最佳实践

• 有选择地在需要模糊匹配的字段上使用三元组词元化。过滤行为将发生显著变化，因为文本过滤将基于三元组词元化的文本进行，而不是整个单词。
• 对需要精确匹配的字段使用 word 或 field 词元化。

更多资源

• 连接到 Weaviate
• API 参考：搜索运算符 # BM25
• 参考：词元化选项

问题和反馈

如果您有任何问题或反馈，请在 用户论坛 中告诉我们。

技术问题

如果您有任何问题，请在我们的 社区论坛 上发帖。

文档反馈

通过打开 GitHub issue 提供反馈。