Corpora

Yöntem: Corpora.create

Boş bir Corpus oluşturur.

Uç nokta

yayınla https://generativelanguage.googleapis.com/v1beta/corpora

İstek içeriği

İstek metni, Corpus öğesinin bir örneğini içerir.

Alanlar
name string

Değişmez. Tanımlayıcı. Corpus kaynak adı. Kimlik ("Corpora/" öneki hariç olmak üzere ad), küçük harfli alfanümerik veya kısa çizgi (-) biçimindeki en fazla 40 karakter içerebilir. Kimlik, tireyle başlayamaz veya bitemez. Oluşturma sırasında ad boşsa displayName'den 12 karakterlik rastgele bir ek ile birlikte benzersiz bir ad türetilir. Örnek: corpora/my-awesome-corpora-123a456b789c

displayName string

İsteğe bağlı. Corpus için kullanıcıların okuyabileceği görünen ad. Görünen ad, boşluklar dahil en fazla 512 karakter uzunluğunda olmalıdır. Örnek: "Semantik Retriever ile ilgili Dokümanlar"

Yanıt gövdesi

Başarılı olursa yanıt metni, yeni oluşturulmuş bir Corpus örneği içerir.

Yöntem: corpora.query

Corpus üzerinde anlamsal arama gerçekleştirir.

Uç nokta

yayınlayacağım https://generativelanguage.googleapis.com/v1beta/{name=corpora/*}:query

Yol parametreleri

name string

Zorunlu. Sorgulanacak Corpus öğesinin adı. Örnek: corpora/my-corpus-123 corpora/{corpora} biçimindedir.

İstek içeriği

İstek metni aşağıdaki yapıyla birlikte verileri içerir:

Alanlar
query string

Zorunlu. Anlamsal arama yapmak için kullanılan sorgu dizesi.

metadataFilters[] object (MetadataFilter)

İsteğe bağlı. Chunk ve Document meta verilerine göre filtreleme yapın. Her MetadataFilter nesnesi benzersiz bir anahtara karşılık gelmelidir. Birden fazla MetadataFilter nesnesi mantıksal "AND"larla birleştirilir.

Belge düzeyinde örnek sorgu: (yıl >= 2020 VEYA yıl < 2010) VE (tür = dram VEYA tür = aksiyon)

MetadataFilter nesne listesi: metadataFilters = [ {key = "document.custom_metadata.year" conditions = [{int_value = 2020, operation = GREATER_EQUAL}, {int_value = 2010, operation = LESS}]}, {key = "document.custom_metadata.year" conditions = [{int_value = 2020, operation = GREATER_EQUAL}, {int_value = 2010, operation = LESS}]}, {key = "document.custom_metadata.genre" conditions = [{stringValue = "drama", operation = EQUAL}, {stringValue = "action", operation = EQUAL}]}]

Sayısal bir değer aralığı için parça düzeyinde örnek sorgu: (yıl > 2015 VE yıl <= 2020)

MetadataFilter nesne listesi: metadataFilters = [ {key = "chunk.custom_metadata.year" conditions = [{int_value = 2015, operation = GREATER}]}, {key = "chunk.custom_metadata.year" conditions = [{int_value = 2020, operation = LESS_EQUAL}]}]

Not: Aynı anahtar için "VE" operatörleri yalnızca sayısal değerlerde desteklenir. Dize değerleri yalnızca aynı anahtar için "VEYA"ları destekler.

resultsCount integer

İsteğe bağlı. Döndürülecek maksimum Chunk sayısı. Hizmet daha az Chunk döndürebilir.

Belirtilmezse en fazla 10 Chunk döndürülür. Belirtilen maksimum sonuç sayısı 100'dür.

Yanıt gövdesi

Alakalı parçaların listesini içeren corpora.query yanıtı.

Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:

Alanlar
relevantChunks[] object (RelevantChunk)

İlgili parçalar.

JSON gösterimi 
{
  "relevantChunks": [
    {
      object (RelevantChunk)
    }
  ]
}

Yöntem: corpora.list

Kullanıcının sahip olduğu tüm Corpora listesini listeler.

Uç nokta

indir https://generativelanguage.googleapis.com/v1beta/corpora

Sorgu parametreleri

pageSize integer

İsteğe bağlı. Döndürülecek maksimum Corpora sayısı (sayfa başına). Hizmet, daha az Corpora sonucu döndürebilir.

Belirtilmemişse en fazla 10 Corpora döndürülür. Maksimum boyut sınırı sayfa başına 20 Corpora'tır.

pageToken string

İsteğe bağlı. Önceki bir corpora.list çağrısından alınan sayfa jetonu.

Yanıtta döndürülen nextPageToken değerini, sonraki sayfayı almak için sonraki isteğin bağımsız değişkeni olarak sağlayın.

Sayfalandırma yapılırken corpora.list parametresine sağlanan diğer tüm parametreler, sayfa jetonunu sağlayan çağrıyla eşleşmelidir.

İstek içeriği

İstek metni boş olmalıdır.

Yanıt gövdesi

corpora.list tarafından gönderilen ve sayfalandırılmış bir Corpora listesi içeren yanıt. Sonuçlar artan corpus.create_time sütununa göre sıralanır.

Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:

Alanlar
corpora[] object (Corpus)

Döndürülen derlemeler.

nextPageToken string

Sonraki sayfayı almak için pageToken olarak gönderilebilecek bir jeton. Bu alan atlanırsa başka sayfa yoktur.

JSON gösterimi 
{
  "corpora": [
    {
      object (Corpus)
    }
  ],
  "nextPageToken": string
}

Yöntem: Corpora.get

Belirli bir Corpus hakkında bilgi alır.

Uç nokta

get https://generativelanguage.googleapis.com/v1beta/{name=corpora/*}

Yol parametreleri

name string

Zorunlu. Corpus adı. Örnek: corpora/my-corpus-123 corpora/{corpora} biçimindedir.

İstek içeriği

İstek metni boş olmalıdır.

Yanıt metni

Başarılıysa yanıt metni, Corpus öğesinin bir örneğini içerir.

Yöntem: corpora.patch

Corpus günceller.

Uç nokta

yama https://generativelanguage.googleapis.com/v1beta/{corpus.name=corpora/*}

PATCH https://generativelanguage.googleapis.com/v1beta/{corpus.name=corpora/*}

Yol parametreleri

corpus.name string

Sabit. Tanımlayıcı. Corpus kaynak adı. Kimlik ("corpora/" ön eki hariç ad), küçük harf alfanümerik karakterler veya kısa çizgiler (-) olmak üzere en fazla 40 karakter içerebilir. Kimlik, kısa çizgiyle başlayamaz veya bitemez. Oluşturma sırasında ad boş olursa 12 karakterlik rastgele bir son ek ile birlikte displayName öğesinden benzersiz bir ad türetilir. Örnek: corpora/my-awesome-corpora-123a456b789c corpora/{corpora} biçimindedir.

Sorgu parametreleri

updateMask string (FieldMask format)

Zorunlu. Güncellenecek alanların listesi. Şu anda bu yöntem yalnızca displayName uygulamasının güncellenmesini destekliyor.

Bu, alanların tam nitelikli adlarının virgülle ayrılmış bir listesidir. Örnek: "user.displayName,photo".

İstek içeriği

İstek metni, Corpus öğesinin bir örneğini içerir.

Alanlar
displayName string

İsteğe bağlı. Corpus için kullanıcıların okuyabileceği görünen ad. Görünen ad, boşluklar dahil en fazla 512 karakter uzunluğunda olmalıdır. Örnek: "Anlamsal Retriever ile ilgili dokümanlar"

Yanıt gövdesi

Başarılıysa yanıt metni, Corpus öğesinin bir örneğini içerir.

Yöntem: corpora.delete

Bir Corpus'yi siler.

Uç nokta

delete https://generativelanguage.googleapis.com/v1beta/{name=corpora/*}

Yol parametreleri

name string

Zorunlu. Corpus öğesinin kaynak adı. Örnek: corpora/my-corpus-123 corpora/{corpora} biçimindedir.

Sorgu parametreleri

force boolean

İsteğe bağlı. Doğru değerine ayarlanırsa bu Corpus ile ilgili tüm Document öğeleri ve nesneler de silinir.

Yanlış ise (varsayılan) Corpus herhangi bir Document içeriyorsa FAILED_PRECONDITION hatası döndürülür.

İstek içeriği

İstek metni boş olmalıdır.

Yanıt gövdesi

Başarılı olursa yanıt gövdesi boş olur.

REST Kaynağı: corpora.permissions

Kaynak: İzin

İzin kaynağı, kullanıcıya, gruba veya dünyanın geri kalanına PaLM API kaynağına (ör. hassaslaştırılmış model, korpus) erişim izni verir.

Rol, kullanıcıların PaLM API kaynaklarında belirli işlemleri gerçekleştirmesine olanak tanıyan izin verilen işlemlerden oluşan bir koleksiyondur. Bunları kullanıcılar, gruplar veya hizmet hesaplarında kullanılabilir hale getirmek için roller atarsınız. Bir rol atadığınızda, rolün içerdiği izinleri verirsiniz.

Üç eş merkezli rol vardır. Her rol, önceki rolün izin verilen işlemlerinin üst kümesidir:

  • Okuyucu, kaynak (ör. ayarlanmış model, kitaplık) için çıkarım yapabilir
  • Yazar, okuyucunun izinlerine sahiptir ve ayrıca düzenleyebilir ve paylaşabilir.
  • sahibi, yazar izinlerine sahiptir ve ayrıca
Alanlar
name string

Yalnızca çıkış. Tanımlayıcı. İzin adı. Oluşturma sırasında benzersiz bir ad oluşturulur. Örnekler: TunedModels/{tunedModel}/permissions/{permission} Corpora/{Corpus}/permissions/{permission} Yalnızca çıkış.

granteeType enum (GranteeType)

İsteğe bağlı. Değişmez. Bağış alan tarafın türü.

emailAddress string

İsteğe bağlı. Sabit. Bu iznin ait olduğu kullanıcı veya grubun e-posta adresi. İznin veriliş türü HERKES olduğunda alan ayarlanmaz.

role enum (Role)

Zorunlu. Bu izinle verilen rol.

JSON gösterimi 
{
  "name": string,
  "granteeType": enum (GranteeType),
  "emailAddress": string,
  "role": enum (Role)
}

GranteeType

Bu izni alan kişilerin türlerini tanımlar.

Sıralamalar
GRANTEE_TYPE_UNSPECIFIED Varsayılan değerdir. Bu değer kullanılmamaktadır.
USER Bir kullanıcıyı temsil eder. Ayarlandığında, kullanıcı için emailAddress değerini sağlamanız gerekir.
GROUP Bir grubu temsil eder. Bu parametre ayarlandığında grup için emailAddress'i sağlamanız gerekir.
EVERYONE Herkese erişimi temsil eder. Ek bilgi gerekmez.

Rol

Bu izinle verilen rolü tanımlar.

Sıralamalar
ROLE_UNSPECIFIED Varsayılan değer. Bu değer kullanılmamaktadır.
OWNER Sahibi kaynağı kullanabilir, güncelleyebilir, paylaşabilir ve silebilir.
WRITER Yazar, kaynağı kullanabilir, güncelleyebilir ve paylaşabilir.
READER Okuyucu kaynağı kullanabilir.

MetadataFilter

Almayı Chunk veya Document düzeyindeki meta veri değerlerine göre sınırlamak için kullanıcı tarafından sağlanan filtre. Örnek (tür = drama VEYA tür = aksiyon): key = "document.custom_metadata.TYPE" conditions = [{stringValue = &quot;drama&quot;, operation = EQUAL}, {stringValue = &quot;action&quot;, operation = EQUAL}]

Alanlar
key string

Zorunlu. Filtrelemek için kullanılacak meta verinin anahtarı.

conditions[] object (Condition)

Zorunlu. Bu filtreyi tetikleyecek belirli bir anahtar için Condition değerleri. Birden fazla Condition, mantıksal OR ile birleştirilir.

JSON gösterimi 
{
  "key": string,
  "conditions": [
    {
      object (Condition)
    }
  ]
}

Koşul

Tek bir anahtar için geçerli filtre koşulu.

Alanlar
operation enum (Operator)

Zorunlu. Koşulu tetiklemek için belirli bir anahtar/değer çiftine uygulanan operatör.

Birlik alanı value. Değer türü, karşılık gelen anahtarın alanında tanımlanan değer türüyle tutarlı olmalıdır. Değer türleri tutarlı değilse sonuç boş bir küme olarak gösterilir. CustomMetadata, StringList değer türüne sahip olduğunda filtreleme koşulu, INCLUDES/EXCLUDES işlemiyle birlikte string_value kullanmalıdır. Aksi takdirde sonuç da boş bir küme olur. value yalnızca aşağıdakilerden biri olabilir:
stringValue string

Meta verilerin filtreleneceği dize değeri.

numericValue number

Meta verilerin filtreleneceği sayısal değerdir.

JSON gösterimi 
{
  "operation": enum (Operator),

  // Union field value can be only one of the following:
  "stringValue": string,
  "numericValue": number
  // End of list of possible types for union field value.
}

Operatör

Bir anahtar/değer çiftine uygulanabilecek geçerli operatörleri tanımlar.

Sıralamalar
OPERATOR_UNSPECIFIED Varsayılan değerdir. Bu değer kullanılmamaktadır.
LESS Sayısal değerler desteklenir.
LESS_EQUAL Sayılarla desteklenir.
EQUAL Sayısal ve dize.
GREATER_EQUAL Sayısal değerler desteklenir.
GREATER Sayılarla desteklenir.
NOT_EQUAL Sayısal ve dize.
INCLUDES Dizeye göre yalnızca belirtilen anahtar için CustomMetadata değer türü stringListValue olduğunda desteklenir.
EXCLUDES Dizeye göre yalnızca belirtilen anahtar için CustomMetadata değer türü stringListValue olduğunda desteklenir.

RelevantChunk

Bir sorguyla alakalı parçanın bilgileri.

Alanlar
chunkRelevanceScore number

Chunk sorguyla alaka düzeyi.

chunk object (Chunk)

Chunk ile ilişkilendirilir.

JSON gösterimi 
{
  "chunkRelevanceScore": number,
  "chunk": {
    object (Chunk)
  }
}

REST Kaynağı: Corpora

Kaynak: Corpus

Corpus, Document'lerden oluşan bir koleksiyondur. Bir proje en fazla 5 topluluk oluşturabilir.

Alanlar
name string

Sabit. Tanımlayıcı. Corpus kaynağının adı. Kimlik ("Corpora/" öneki hariç olmak üzere ad), küçük harfli alfanümerik veya kısa çizgi (-) biçimindeki en fazla 40 karakter içerebilir. Kimlik, tireyle başlayamaz veya bitemez. Oluşturma sırasında ad boşsa displayName'den 12 karakterlik rastgele bir ek ile birlikte benzersiz bir ad türetilir. Örnek: corpora/my-awesome-corpora-123a456b789c

displayName string

İsteğe bağlı. Corpus için kullanıcıların okuyabileceği görünen ad. Görünen ad, boşluklar dahil en fazla 512 karakter uzunluğunda olmalıdır. Örnek: "Anlamsal Retriever ile ilgili dokümanlar"

createTime string (Timestamp format)

Yalnızca çıkış. Corpus öğesinin oluşturulduğu zaman damgası.

RFC3339 UTC "Zulu" zaman damgası biçiminde olmalıdır. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z".

updateTime string (Timestamp format)

Yalnızca çıkış. Corpus öğesinin en son güncellendiği zaman damgası.

Nanosaniye çözünürlüğüne sahip ve en fazla dokuz kesirli basamak içeren RFC3339 UTC "Zulu" biçiminde bir zaman damgası. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z".

JSON gösterimi 
{
  "name": string,
  "displayName": string,
  "createTime": string,
  "updateTime": string
}