Corpora

REST Kaynağı: Corpora

Kaynak: Topluluk

Corpus, Document öğelerinden oluşan bir koleksiyondur. Bir proje en fazla 5 topluluk oluşturabilir.

JSON gösterimi 
{
  "name": string,
  "displayName": string,
  "createTime": string,
  "updateTime": string
}
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ş olursa 12 karakterlik rastgele bir son ek ile birlikte displayName öğesinden 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"

createTime string (Timestamp format)

Yalnızca çıkış. Corpus öğesinin oluşturulduğu zamana ait 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üncellenişinin 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".

Yöntem: Corpora.create

Boş bir Corpus oluşturur.

Uç nokta

yayınlayacağım https://generativelanguage.googleapis.com/v1beta/corpora

İstek içeriği

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

Yanıt gövdesi

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

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.

Belirtilmezse 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 corpora.list çağrısından alınan bir 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.

Sayfalara ayırma işlemi sırasında corpora.list öğesine 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 yanıt, sayfalara ayrılmış Corpora listesi içeriyor. 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 derleme.

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.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 gövdesi, aşağıdaki yapıya sahip verileri içerir:

Alanlar
query string

Zorunlu. Anlamsal arama gerçekleştirmek için sorgu dizesi.

metadataFilters[] object (MetadataFilter)

İsteğe bağlı. Chunk ve Document meta verileri için filtre uygulayın. Her MetadataFilter nesnesi benzersiz bir anahtara karşılık gelmelidir. Birden fazla MetadataFilter nesne, mantıksal "AND" ifadeleriyle 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: metadataFiltreler = [ {key = "document.custom_metadata.year" koşullar = [{int_value = 2020, işlem = GREATER_EQUAL}, {int_value = 2010, işlem = LESS}]}, {anahtar = "document.custom_metadata.year" koşullar = [{int_value = 2020, işlem = GREATER_EQUAL}, {int_value = 2010, işlem = LESS}]}, {anahtar = "document.custom_metadata.Tür" koşulları = [{stringValue = "drama", transaction = EQUAL}, {stringValue = "action", transaction = 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: meta verilerinizdeki filtre = [ {key = "chunk.custom_metadata.year" conditions = [{int_value = 2015, operation = GREATER}]}, {key = &quot;chunk.custom_metadata.year&quot; koşullar = [{int_value = 2020, işlem = LESS_EQUAL}]}]

Not: Aynı anahtara yönelik "VE" ifadeleri yalnızca sayısal değerler için desteklenir. Dize değerleri aynı anahtar için yalnızca "OR" anahtar kelimelerini destekler.

resultsCount integer

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

Belirtilmemişse 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)

Alakalı parçalar.

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

Yöntem: Corpora.get

Belirli bir Corpus ile ilgili bilgileri alır.

Uç nokta

indir 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 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ş 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, tam nitelikli alan 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.

Yanıt gövdesi

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

Yöntem: Corpora.delete

Corpus öğesini siler.

Uç nokta

sil 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ış (varsayılan) değerine ayarlanırsa Corpus herhangi bir Document içerdiğinde 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ış bir model, topluluk) erişim izni verir.

Rol, kullanıcıların PaLM API kaynakları üzerinde belirli işlemleri gerçekleştirmesine olanak tanıyan izin verilen işlemler koleksiyonudur. 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, çıkarım için kaynağı (ör. hassaslaştırılmış model, topluluk) kullanabilir
  • yazar, okuyucu izinlerine sahiptir ve ayrıca düzenleyip paylaşabilir
  • sahibin yazar izinleri vardır ve bu kişiler ayrıca silebilir
JSON gösterimi 
{
  "name": string,
  "granteeType": enum (GranteeType),
  "emailAddress": string,
  "role": enum (Role)
}
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ı. Sabit. Bağış alan tarafın türü.

emailAddress string

İsteğe bağlı. Sabit. Bu iznin ait olduğu gruptaki kullanıcının e-posta adresi. İznin bağış alan türü EVERYONE olduğunda alan ayarlanmaz.

role enum (Role)

Zorunlu. Bu izinle verilen rol.

GranteeType

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

Sıralamalar
GRANTEE_TYPE_UNSPECIFIED Varsayılan değerdir. Bu değer kullanılmıyor.
USER Bir kullanıcıyı temsil eder. Bu parametre ayarlandığında kullanıcı için emailAddress'i 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 bilgiye gerek yoktur.

Rol

Bu izinle verilen rolü tanımlar.

Sıralamalar
ROLE_UNSPECIFIED Varsayılan değerdir. Bu değer kullanılmıyor.
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 = dram VEYA tür = aksiyon): key = "document.custom_metadata.TYPE" condition = [{stringValue = "drama", transaction = EQUAL}, {stringValue = "action", transaction = EQUAL}]

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

Zorunlu. Filtrelenecek meta verilerin anahtarı.

conditions[] object (Condition)

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

Koşul

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

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.
}
Alanlar
operation enum (Operator)

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

Birleştirme 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şulunda DAHİL ET/HARİÇ TUT işlemiyle eşlenmiş string_value kullanılmalıdır. Aksi takdirde sonuç da boş bir küme olur. value şunlardan yalnızca biri olabilir:
stringValue string

Meta verilerin filtreleneceği dize değeri.

numericValue number

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

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ılmıyor.
LESS Sayılarla desteklenir.
LESS_EQUAL Sayılarla desteklenir.
EQUAL Sayısal ve dize.
GREATER_EQUAL Sayılarla 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.

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

Sorguyla Chunk alaka düzeyi.

chunk object (Chunk)

Sorguyla ilişkili Chunk.